# yeartodate – função de script e gráfico

Esta função descobre se a data de entrada cai dentro de um ano da data em que o script foi carregado pela última vez, e retorna True se cair, False se não cair.

Sintaxe:

YearToDate(timestamp [ , yearoffset [ , firstmonth [ , todaydate] ] ])

**Tipo de dados de retorno:** Booleano

Se nenhum dos parâmetros opcionais for usado, o acumulado no ano será qualquer data que ocorrer dentro de um ano civil, a partir de 1º de janeiro até a data da última execução do script, inclusive.

Argumentos:

Argumentos YearToDate

| Argumento | Descrição |
| --- | --- |
| timestamp | A data para avaliar como carimbo de data/hora ou a expressão resolvendo para um carimbo de data/hora, por exemplo “2012-10-12”. |
| yearoffset | Ao especificar um yearoffset, yeartodate retorna True para o mesmo período em outro ano. Um yearoffset negativo indica um ano anterior e um offset positivo um ano futuro. O year-to-date mais recente é alcançado ao especificar yearoffset = -1. Se omitido, o valor 0 é assumido. |
| firstmonth | Ao especificar um firstmonth entre 1 e 12 (1, se omitido), o início do ano pode avançar para o primeiro dia de qualquer mês. Por exemplo, para trabalhar com um ano fiscal que inicia em 1º de maio, especifique firstmonth = 5. |
| todaydate | Ao especificar um todaydate (carimbo de data/hora da execução do último script, se omitido), é possível mover o dia usado como o limite superior do período. |

Exemplos e resultados:

Os exemplos a seguir assumem o último momento de recarregamento = 2011-11-18

Exemplos e resultados

| Exemplo | Resultado |
| --- | --- |
| `yeartodate( '2010-11-18')` | retorna False |
| `yeartodate( '2011-02-01')` | retorna True |
| `yeartodate( '2011-11-18')` | retorna True |
| `yeartodate( '2011-11-19')` | retorna False |
| `yeartodate( '2011-11-19', 0, 1, '2011-12-31')` | retorna True |
| `yeartodate( '2010-11-18', -1)` | retorna True |
| `yeartodate( '2011-11-18', -1)` | retorna False |
| `yeartodate( '2011-04-30', 0, 5)` | retorna False |
| `yeartodate( '2011-05-01', 0, 5)` | retorna True |