MI_SubscriptionDeliveryOptions_GetString function (mi.h)

Gets the value of the named string option.

Syntax

MI_INLINE MI_Result MI_SubscriptionDeliveryOptions_GetString(
  [in]            MI_SubscriptionDeliveryOptions *self,
                  const MI_Char                  *optionName,
                  const MI_Char                  **value,
  [out, optional] MI_Uint32                      *index,
  [out, optional] MI_Uint32                      *flags
);

Parameters

[in] self

A MI_SubscriptionDeliveryOptions structure.

optionName

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

value

A pointer to a null-terminated string containing the returned option value.

[out, optional] index

Returned zero-based index of option.

[out, optional] flags

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.

Requirements

See also

MI_SubscriptionDeliveryOptions

MI_SubscriptionDeliveryOptions_SetString