API Documentation

NxST_EXDIVIDENDATTRIB(15) - Ex Dividend Attribute Flags


#define Value Comments
Canadian 0x00000001
Special 0x00000002
Extra 0x00000004
ExtraOrdinary 0x00000008
Increase 0x00000010
Initial 0x00000020
SaleOfRights 0x00000040
Approximate 0x00000080
OrdinaryIncome 0x00000100
ExRights 0x00000200
PercentDistribution 0x00000400
ToBeAnnounced 0x00000800
Final 0x00001000
Decrease 0x00002000
PaymentInStock 0x00004000
SemiAnnual 0x00008000
Annual 0x00010000
PaymentInKind 0x00020000
ShortTermCapitalGains 0x00040000
CapitalGains 0x00080000
Equivalence 0x00100000
GrossAmount 0x00200000
LiquidityDistribution 0x00400000
PaymentInCashOrStock 0x00800000
CorrectedAmount 0x01000000
Monthly 0x02000000
Multiple 0x04000000
Estimating 0x08000000 This ExDividend was estimated due to a discrepancy in the previous close price sent on the current day versus what was recorded on the last tape. If Nanex feed processors did not receive an ExDividend or Split message for the instrument in question, the ExDivident Attribute flag is set to the Estimating value so that NxCore users can choose to use the estimated data, or disregard it in favor of waiting for an ExDividend message without the Estimating flag set. The Estimating ExDivident Attribute Flag was implemented to compensate for the lack of standardization the way exchanges disseminate data that are not a Quote or Trade.
ReturnOfCapital 0x10000000

You may use code from a helper header file

You may use the code below in your own program



// example
   bool bIsCanadian              = (field & nxST_EXDIVIDENDATTRIB::Canadian)              != 0;
   bool bIsSpecial               = (field & nxST_EXDIVIDENDATTRIB::Special)               != 0;
   bool bIsExtra                 = (field & nxST_EXDIVIDENDATTRIB::Extra)                 != 0;
   bool bIsExtraOrdinary         = (field & nxST_EXDIVIDENDATTRIB::ExtraOrdinary)         != 0;
   bool bIsIncrease              = (field & nxST_EXDIVIDENDATTRIB::Increase)              != 0;
   bool bIsInitial               = (field & nxST_EXDIVIDENDATTRIB::Initial)               != 0;
   bool bIsSaleOfRights          = (field & nxST_EXDIVIDENDATTRIB::SaleOfRights)          != 0;
   bool bIsApproximate           = (field & nxST_EXDIVIDENDATTRIB::Approximate)           != 0;
   bool bIsOrdinaryIncome        = (field & nxST_EXDIVIDENDATTRIB::OrdinaryIncome)        != 0;
   bool bIsExRights              = (field & nxST_EXDIVIDENDATTRIB::ExRights)              != 0;
   bool bIsPercentDistribution   = (field & nxST_EXDIVIDENDATTRIB::PercentDistribution)   != 0;
   bool bIsToBeAnnounced         = (field & nxST_EXDIVIDENDATTRIB::ToBeAnnounced)         != 0;
   bool bIsFinal                 = (field & nxST_EXDIVIDENDATTRIB::Final)                 != 0;
   bool bIsDecrease              = (field & nxST_EXDIVIDENDATTRIB::Decrease)              != 0;
   bool bIsPaymentInStock        = (field & nxST_EXDIVIDENDATTRIB::PaymentInStock)        != 0;
   bool bIsSemiAnnual            = (field & nxST_EXDIVIDENDATTRIB::SemiAnnual)            != 0;
   bool bIsAnnual                = (field & nxST_EXDIVIDENDATTRIB::Annual)                != 0;
   bool bIsPaymentInKind         = (field & nxST_EXDIVIDENDATTRIB::PaymentInKind)         != 0;
   bool bIsShortTermCapitalGains = (field & nxST_EXDIVIDENDATTRIB::ShortTermCapitalGains) != 0;
   bool bIsCapitalGains          = (field & nxST_EXDIVIDENDATTRIB::CapitalGains)          != 0;
   bool bIsEquivalence           = (field & nxST_EXDIVIDENDATTRIB::Equivalence)           != 0;
   bool bIsGrossAmount           = (field & nxST_EXDIVIDENDATTRIB::GrossAmount)           != 0;
   bool bIsLiquidityDistribution = (field & nxST_EXDIVIDENDATTRIB::LiquidityDistribution) != 0;
   bool bIsPaymentInCashOrStock  = (field & nxST_EXDIVIDENDATTRIB::PaymentInCashOrStock)  != 0;
   bool bIsCorrectedAmount       = (field & nxST_EXDIVIDENDATTRIB::CorrectedAmount)       != 0;
   bool bIsMonthly               = (field & nxST_EXDIVIDENDATTRIB::Monthly)               != 0;
   bool bIsMultiple              = (field & nxST_EXDIVIDENDATTRIB::Multiple)              != 0;
   bool bIsEstimating            = (field & nxST_EXDIVIDENDATTRIB::Estimating)            != 0;
   bool bIsReturnOfCapital       = (field & nxST_EXDIVIDENDATTRIB::ReturnOfCapital)       != 0;
}