Skip to main content

Windows Dev Center

MI_SubscriptionDeliveryOptions_GetNumber function

Gets the value of the named numeric option.

Syntax


 MI_INLINE MI_Result MI_SubscriptionDeliveryOptions_GetNumber(
  _Inout_   MI_SubscriptionDeliveryOptions *self,
            _In_z_ const MI_Char           *optionName,
  _Out_     MI_Uint32                      *value,
  _Out_opt_ MI_Uint32                      *index,
  _Out_opt_ MI_Uint32                      *flags
);

Parameters

self [in, out]

A pointer to a MI_SubscriptionDeliveryOptions structure.

optionName

A null-terminated string that represents the name of the option.

value [out]

Returned option value.

index [out, optional]

Returned zero-based index of the option.

flags [out, optional]

Returned option flags.

Return value

A value of the MI_Result enumeration that specifies the function return code. This can be one of the following codes.

Return codeDescription
MI_RESULT_OK

The operation succeeded.

MI_RESULT_SERVER_LIMITS_EXCEEDED

There is not enough memory to complete the request.

MI_RESULT_INVALID_PARAMETER

One or more parameters passed to the function were not valid.

MI_RESULT_FAILED

A failure not covered by other MI_Result error codes.

 

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Redistributable

Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2

Header

Mi.h

See also

MI_SubscriptionDeliveryOptions
MI_SubscriptionDeliveryOptions_SetNumber