Certex- A DLL que confere um produto Software Atelier Certex 2002 versão 1,0
Validação
certex_isValid
certex_isCreditCard
» certex_creditCardFlag
certex_isDigit
Informação DLL
certex_getLicType
certex_getLicInfo
» certex_licUser
» certex_licNum
certex_getVersion
» certex_dllVersion
Formatação
certex_getFormat
certex_setFormat
» certex_format
certex_getQntDigits
Auxiliares
certex_getUFName
» certex_ufName
certex_getDocName
» certex_docName

Validação


certex_isValid
Confere a validade do documento.

BYTE certex_isValid( const BYTE nDocType, const LPTSTR lpDocUF, const LPTSTR lpDocNum )

Parâmetros:

Retorna:

certex_result_VALIDO Número de documento correto
certex_result_INVALIDO Número de documento inválido
certex_result_SEM_NUM_DOC O parâmetro lpDocUF é nulo
certex_result_TIPO_DOC_DESCONHECIDO O parâmetro nDocType é desconhecido
certex_result_UF_DESCONHECIDA O parâmetro lpDocUF é desconhecido
certex_result_MUNICIPIO_DESCONHECIDOA Inscrição Estadual se refere a um Município desconhecido
certex_result_NUM_DOC_CHR_INVALIDO Foi encontrado um caractere inválido no parâmetro lpDocNum
certex_result_NUM_DOC_LEN_INVALIDO O número de caracteres do documento não é o esperado
certex_result_DESCONHECIDO Ocorreu um erro inesperado


certex_isCreditCard
Confere a validade do número de Cartão de Crédito e, opcionalmente, informa a bandeira.

BYTE certex_isCreditCard( const LPTSTR lpCC_Num, const DWORD wBufferLen, LPTSTR lpBuffer )

Parâmetros:

Retorna:

certex_result_VALIDO Número de Cartão de Crédito correto
certex_result_INVALIDO Número de Cartão de Crédito inválido
certex_result_SEM_NUM_DOC O parâmetro lpCC_Num é nulo
certex_result_NUM_DOC_CHR_INVALIDO Foi encontrado um caractere inválido no parâmetro lpCC_Num
certex_result_NUM_DOC_LEN_INVALIDO O número de caracteres do documento não é o esperado
certex_result_DESCONHECIDO Ocorreu um erro inesperado

Função Derivada (utilização de string)

Retorna:
Uma string vazia se o número do Cartão de Crédito estiver errado. Se o número estiver correto e for de bandeira conhecida, retorna o nome da bandeira. Se não for conhecida retorna a string Bandeira desconhecida.


certex_isDigit
Confere a validade dos caracteres informados.

BYTE certex_isDigit( const BYTE nDocType, const LPTSTR lpDocUF, const LPTSTR lpDocNum, int* iDigit )

Parâmetros:

Retorna:

certex_digits_OK Os dígitos são corretos (más poderia ser um documento inválido)
certex_digits_INVALID O dígito iDigit não é valido para o documento informado
certex_digits_FALTAM Faltam iDigit para ser um número válido
certex_digits_SOBRAM Sobram iDigit para ser um número válido
certex_digits_ERRO Ocorreu um erro inesperado


Informação da DLL


certex_getLicType
Informa o tipo de Licença da DLL em utilização e, opcionalmente, valida a Chave de Licença.

Nota: Se esta função não é chamada com a Chave de Licença correta, a DLL se comportará como uma DLL de avaliação. A DLL de avaliação demora propositalmente alguns segundos para retornar das funções de validação.

BYTE certex_getLicType( const LPTSTR lpLicKey )

Parâmetro:

Retorna:

certex_lic_TYPE_REGISTERED É uma cópia registrada
certex_lic_TYPE_DEMO É uma cópia de avaliação
certex_lic_TYPE_AS_DEMO É uma cópia registrada, mas não foi informada a Chave de Licença lpLicKey
certex_lic_ERROR_NOT_INITED O código de inicialização não foi executado pelo Sistema Operacional
certex_lic_ERROR_CANT_RETRIVENão foi possível obter informação, verifique com a janela Propriedades do Windows
certex_lic_ERROR_NOT_FOUND Não foi encontrada a informação, verifique com a janela Propriedades do Windows
certex_lic_ERROR_CRC A DLL está corrupta, é recomendável excluí-a do sistema (pode tratar-se de um virus)
certex_lic_ERROR_INVALID_KEY A Chave de Licença informada é inválida
certex_lic_ERROR_UNKNOW Ocorreu um erro inesperado


certex_getLicInfo
Obtém informação sobre a Licença de Uso.

DWORD certex_getLicInfo( const BYTE nInfoType, const DWORD wBufferLen, LPTSTR lpBuffer )

Parâmetros:

Retorna:

Funções Derivadas (utilização de string)

Retornam:
String com as informações solicitadas.


certex_getVersion
Informa a versão da DLL em utilização.

WORD certex_getVersion( )

Parâmetros:

Nenhum.

Retorna:

No byte alto (hibyte) major e no baixo minor da versão.

Função Derivada (utilização de string)

Retorna:
String com a versão da DLL em utilização.


Formatação


certex_getFormat
Obtém a máscara de formatação para o documento especifcado.

DWORD certex_getFormat( const BYTE nDocType, const LPTSTR lpDocUF, const LPTSTR lpDocNum, const DWORD wBufferLen, LPTSTR lpBuffer )

Parâmetros:

Retorna:

A quantidade de caracteres necessários para escrever a máscara, sem contar o zero final. Se (wBufferLen > 0), escreve wBufferLen caracteres da máscara em lpBuffer.

nDocType Buffer
certex_doc_type_CNPJ ##.###.###/####-##
certex_doc_type_CPF #########.##
certex_doc_type_PIS ###.#####.##-#
certex_doc_type_TITULO #########-##.##
certex_doc_type_IE Depende da UF e, em alguns casos, do número
certex_doc_type_CC #### #### #### ...


certex_setFormat
Formata o número do documento informado. O número não é validado. Todo caractere inválido, para o tipo de documento, é ignorado.

DWORD certex_setFormat( const BYTE nDocType, const LPTSTR lpDocUF, const LPTSTR lpDocNum, const DWORD wBufferLen, LPTSTR lpBuffer )

Parâmetros:

Retorna:

A quantidade de caracteres necessários para escrever o número formatado, sem contar o zero final. Se (wBufferLen > certex_getFormat()), escreve o número formatado em lpBuffer.

Funções Derivadas (utilização de string)

Retorna:
Uma string com o número de documento formatado.


certex_getQntDigits
Retorna o número máximo de digitos esperados para o documento informado.

BYTE certex_getQntDigits( const BYTE nDocType, const LPTSTR lpDocUF, const LPTSTR lpDocNum )

Parâmetros:

Retorna:

A quantidade de caracteres máximos esperados para o tipo de documento informado.

nDocType Retorna
certex_doc_type_CNPJ 14
certex_doc_type_CPF 11
certex_doc_type_PIS 11
certex_doc_type_TITULO 13
certex_doc_type_IE Depende da UF, em alguns casos, do número. (Se a UF não é informada, retorna o maior)
certex_doc_type_CC Máximo permitido


Auxiliares


certex_getUFName
Escreve no buffer a sigla ou nome por extenso da Unidade Federativa solicitada.

DWORD certex_getUFName( const BYTE nUF, const INT iShort, LPTSTR lpBuffer )

Parâmetros:

Retorna:

A quantidade de caracteres necessários para escrever o solicitado, sem contar o zero final. Se lpBuffer não é nulo, escreve a informação solicitada. O buffer deve ter espaço suficiente.

Função Derivada (utilização de string)

Retorna:
Uma string com a sigla ou nome por extenso da Unidade Federativa solicitada.


certex_getDocName
Escreve no buffer o nome do documento solicitado.

DWORD certex_getDocName( const BYTE nDocType, const DWORD wBufferLen, LPTSTR lpBuffer )

Parâmetros:

Retorna:

A quantidade de caracteres necessários para escrever o nome do documento, sem contar o zero final. Se lpBuffer não é nulo, escreve o nome do documento ate wBufferLen caracteres.

Função Derivada (utilização de string)

Retorna:
Uma string com o nome do documento solicitado.







© SAtelier−2010 desde junho/2003