99923910 Funciones SDK ADMW

Pgina: 1

Funciones del

SDK de ADMINPAQ

72020120601

Pgina: 2

INTRODUCCIN Qu es un SDK

Software Development Kit (SDK) o kit de desarrollo de software. Es generalmente un conjunto de herramientas de desarrollo que le permite a un programador crear aplicaciones para un sistema bastante concreto, por ejemplo ciertos paquetes de software, frameworks, plataformas de hardware, ordenadores, videoconsolas, sistemas operativos, etctera. En el caso de AdminPAQ, el SDK es un conjunto de archivos que contienen funciones publicadas, las cuales pueden ser usadas por desarrolladores externos para manipular (consultar o modificar) informacin de la base de datos de AdminPAQ.

Cmo funciona

Las funciones disponibles en el SDK se comunican con AdminPAQ a travs de mtodos de clases, stas a su vez hacen llamados a las clases base de AdminPAQ, es decir, a las clases usadas dentro de AdminPAQ. El SDK controla la concurrencia en un ambiente multiusuario, es decir las funciones dan el soporte para los bloqueos y protegen los accesos. (Permite operar como si se tratara de una estacin de AdminPAQ). Protege las bases de datos, sus relaciones y sigue las reglas de negocio de AdminPAQ.

Pgina: 3

Requerimientos para trabajar con el SDK

Ambiente

AdminPAQ instalado (monousuario o como estacin). En caso de no tener instalado AdminPAQ es necesario contar con los archivos que conforman el SDK

de AdminPAQ en la misma carpeta donde reside la aplicacin en desarrollo. Microsoft Excel (cualquier versin) - Para desarrollo de modelos u Hojas electrnicas. Entorno de programacin. Editor/Compilador del lenguaje elegido

(VB / Delphi / C / Plataforma .net, etc).

Archivos usados por el SDK. Todos estos archivos se pueden copiar a la ubicacin donde reside la aplicacin en desarrollo.

Archivo Descripcin Ubicacin MGW_SDK.dll Es la interfase del SDK con AdminPAQ.

Libreria de encadenado, aqu se encuentran las funciones del SDK.

C:\Archivos de programa\Compacw\AdminPAQ

MGW_SDK.h Encabezado que contiene la declaracin de las funciones, constates y estructuras definidas en C++ Builder.

C:\Archivos de programa\Compacw\AdminPAQ\SDK

MGW_SDK.lib Libreria que contiene las funciones del SDK de AdminPAQ, generada con C++ Builder.

C:\Archivos de programa\Compacw\AdminPAQ\SDK

CAC000.dll CAC100.dll CAC200.dll CAC300.dll CAC400.dll CAC500.dll CAC600.dll CAC700.dll CAC800.dll

Modelo de componentes compuestos C:\Archivos de programa\Compacw\AdminPAQ

CACc4dll.dll Motor BDD C:\Archivos de programa\Compacw\AdminPAQ

caccodebase.dll Motor BDD C:\Archivos de programa\Compacw\AdminPAQ

CACEsp.dll Textos C:\Archivos de programa\Compacw\AdminPAQ

Estandar.mgw Textos/Dialogos/Mensajes C:\Archivos de programa\Compacw\AdminPAQ

MGW000.dll MGW001.dll MGW002.dll

Reglas de negocio AdminPAQ C:\Archivos de programa\Compacw\AdminPAQ

MgwEsp.dll Textos C:\Archivos de programa\Compacw\AdminPAQ

DBFWIN32.DLL BDEWIN.DLL

Funciones genricas de lectura utilizada por los sistemas de Computacin en Accin. En el caso de AdminPAQ se hace uso del DBFWIN32.DLL .

C:\Archivos de programa\Compacw\AdminPAQ

Importante: Se debe tener especial cuidado con el control de versiones con el SDK en la que se desarrolla una aplicacin y la versin de AdminPAQ con la que va a interactuar. Es decir, no se recomienda desarrollar una aplicacin con el SDK de AdminPAQ 2.4.5 para interactuar con un AdminPAQ 3.1.2.

Pgina: 4

RECOMENDACIONES Y CONSIDERACIONES IMPORTANTES Tips y Conceptos Bsicos

Antes de hacer accesos mediante el SDK, asegurarse que AdminPAQ funciona correctamente y que la informacin que est generando es correcta.

Estar familiarizado con la estructura de la Base de Datos de AdminPAQ.

Tener claro y bien conceptualizado el fin y el alcance de la aplicacin a desarrollar.

Ir por partes, es decir: Primero crear la conexin a la base de datos, inicializar el SDK y generar un

documento desde la aplicacin; posteriormente verificar que funciona correctamente (que se crea sin problemas el documento en AdminPAQ).

Modularizar el cdigo (Si el entorno de programacin lo permite). Esto es crear diversos mdulos para separar funcionalidad global y local. Ejemplo: Usar un mdulo en el cual se realice la declaracin de constantes, variables globales, estructuras de datos y enlace a las funciones del archivo MGW_SDK.DLL; y usar otro modulo para las funciones creadas por el desarrollador y que modificaran la informacin que se recibe y enva de la Base de Datos de AdminPAQ. Esto facilitar la portabilidad y la reutilizacin de cdigo, as como el mantenimiento y actualizacin de la funcionalidad.

Revisar que los documentos y sus movimientos se graban/actualizan de manera correcta en AdminPAQ.

Validar desde la aplicacin que se desarrolla que los datos que se envan sea consistente y que tenga el

formato correcto.

Probar continuamente la aplicacin con todas las posibles combinaciones que permita.

Pgina: 5

Funciones Obligatorias

Son las funciones que forzosamente deben incluirse en cualquier aplicacin que use el SDK:

El mtodo, a grandes ragos, se compone de:

Inicializar el SDK al inicio de cada proceso. fInicializaSDK. Esta funcin se llama una sola vez al iniciar un proceso o accin completa. Ejemplo: El alta de un documento y todos sus movimientos. Se inicia el SDK, se hace el llamado a todas las funciones requeridas y luego se termina el SDK.

Funciones para abrir y cerrar empresa:

Se usan para indicar las bases de datos de la empresa a la cual afectar la aplicacin que hace uso del SDK. (fAbreEmpresa / fCierraEmpresa) Solo se puede trabajar en una empresa a la vez (a menos que se corran la misma aplicacin dos veces).

Incluir la funcin fError del SDK para recuperar la descripcin de los posibles errores. La mayora de las

funciones regresan un cdigo de error, donde 0 indica que no se presentaron errores y un numero diferente de 0 cuando ocurri algn error. Se utiliza la funcin fError para recuperar la descripcin de dicho error.

Usar siempre la funcin fTerminaSDK para liberar todos los recursos solicitados por el SDK, al final de

cada proceso completo. sta funcin se llama una sola vez al finalizar un proceso o accin completa.

Estructura general de una aplicacin desarrollada con el SDK de AdminPAQ. Inicializar SDK

Abrir Empresa Tu funcin o proceso completo

Cerrar Empresa Terminar SDK

Pgina: 6

Trabajando con documentos Cuando se trabaje con documentos siempre se deben afectar. Al crear documentos La existencia y los costos se afectan, sin emnbargo los acumulados del sistema no, por lo que es necesario despus de crear documentos con sus movimientos correspondientes es necsario afectarlos. En el SDK de AdminPAQ existen dos tipos de afectacin, una para los documentos de cargo y abono y otra para los dems tipos de documento. Estructura general de una aplicacin que da de alta documentos y sus movimientos con el SDK de AdminPAQ. Inicializar SDK

Abrir Empresa Alta de documento

Alta de movimientos Afectar documento

Cerrar Empresa Terminar SDK Estructura general de una aplicacin que da de alta documentos de Cargo y Abono con el SDK de AdminPAQ. Inicializar SDK

Abrir Empresa Alta de documento Cargo/Abono Afectar documento

Cerrar Empresa Terminar SDK Las funciones de afectacin de documentos son: fAfectaDocto_Param () y fAfectaDocto (), bajo y alto nivel respectivamente.

Pgina: 7

Cuando usar funciones de Alto Nivel y cuando de Bajo Nivel

En trminos generales se recomienda usar las funciones de alto nivel debido a que estas realizan todo los procesos necesarios para mantener las reglas de negocio y la base de datos estable. Cualquier lenguaje de programacin que soporte estructuras de datos podr hacer uso de las funciones de alto nivel, la razn es que como generalidad las funciones de alto nivel efectan operaciones con registros completos. Las funciones de bajo nivel permiten ms flexibilidad en cuanto que datos se graban el la base de datos, pero implican ms trabajo, por realizar escritura campo por campo, y complejidad pues se tienen que validar diversos puentos para no romper las reglas de negocio, por lo que para su uso se requiere mas precisin al desarrollar el proceso. Estas funciones se pueden usar en cualquier lenguaje de programacin, ms son de carcter obligatorio en aquellos que no manejen estructuras de datos. Por ejemplo Visual FoxPro. Ejemplo: Dar de alta de datos extras del catlogo slo se puede efectuar con las funciones de bajo nivel Algunos lenguajes como Visual FoxPro no soportan el uso de estructuras de datos, por lo que forzosamente se deben usar las funciones de bajo nivel.

Pgina: 8

Restricciones al usar funciones de Bajo Nivel

Las funciones de bajo nivel permiten la escritura campo a campo en la BD de AdminPAQ, sin embargo existen campos que no pueden ser modificadas por dichas funciones pues son valores que calcula o modifica AdminPAQ.

Campo Razn cIdDocumento Es un dato autogenerado. cIdDocumentoDe Depende de la plantilla del documento. cIdConcepto Es un dato autogenerado. cIdCteProv Es un dato autogenerado. cIdAgente Es un dato autogenerado. cIdConcepto Es un dato autogenerado. cNeto Es un campo calculado. cTotal Es un campo calculado. cAfectado Es un campo protegido. cNaturaleza Es un dato autogenerado. cDocumentoOrigen Es un dato autogenerado. cPlantillacUsaProveedor Es un campo calculado. cUsaCliente Es un dato autogenerado. cNetocTotalUnidades Es un campo calculado. cBanObsevaciones Es un dato autogenerado. cBanDatosEnvio Es un dato autogenerado. cBanCondCredito Es un dato autogenerado. CUnidadesPendientes Es un campo calculado. cTimeStamp Es un dato autogenerado.

Pgina: 9

Recomendaciones para el manejo de cadenas La forma en que cada lenguaje de programacin define los tipos de datos cadena es vara entre lenguajes (en cuanto a su tamao en bytes). Por esta razon los tipos de datos manejados por distintos lenguajes pueden presentar problemas al pasar informacin al SDK. En C++ Builder y Delphi este inconveniente no se presenta. Al usar el SDK en Visual Basic. Para llenar los campos cadena que forman parte de la estructura, es necesario llenar con espacios en blanco las variables tipo cadena hasta alcanzar la longitud requerida por el SDK, por la diferencia que existe con este lenguaje al manejar los tipos de datos. El error que se produce cuando no se llenan adecuadamente las estructuras es codigo no existe Para contrarrestar este error se usan dos funciones de manipulacin de cadenas. La funcin para llenar espacios en Visual Basic es la siguiente:

' Funcin f_RellenaConBlancos Public Sub f_RellenaConBlancos(ByRef aCadena As String, aTamanio As Integer) Dim lEspacios As String Dim lTamanio As Long

lEspacios = Space(aTamanio) lTamanio = aTamanio - Len(Trim(aCadena)) - 1 aCadena = Trim(aCadena) & Left(lEspacios, lTamanio) & Chr(0) End Sub Para realizar comparaciones dentro de VB es necesario quitar el carcter nlo.

' Funcion Quita Caracteres nulos Public Function f_QuitaCaracterNulo(aCadena As String) As String Dim lCadenaTemp As String lCadenaTemp = Replace(aCadena, Chr(0), " ") if_QuitaCaracterNulo = Trim(lCadenaTemp) End Function

Pgina: 10

FUNCIONES GENERALES Inicializacin / Terminacin

fInicializaSDK () Disponibilidad AdminPAQ 2002. Sintaxis fInicializaSDK()

Parmetros No usa.

Retorna Valores enteros: kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito. !kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin Inicializa el SDK de AdminPAQ. Se requiere llamar esta funcin al inicio de cualquier aplicacin que utilice el SDK. Establece la conexin entre la aplicacin desarrollada y la Base de datos de AdminPAQ. Su uso es obligatorio.

Ejemplo El siguiente cdigo inicializa el SDK de AdminPAQ y asigna el resultado a una variable entera que se evala posteriormente; si su valor es distinto de 0 (cero) la aplicacin se detiene.

lError = fInicializaSDK() If lError 0 Then MensajeError lError End End If

Ver tambin fTerminaSDK (), fError() fTerminaSDK ()

Disponibilidad AdminPAQ 2002.

Sintaxis fTerminaSDK ()

Parmetros No usa.

Retorna No tiene valor de retorno.

Descripcin Libera todos los recursos solicitados por el SDK, se requiere llamar al terminar de utilizar el SDK.

Ejemplo El siguiente cdigo termina el SDK de AdminPAQ.

fTerminaSDK()

Ver tambin fInicializaSDK (), fError()

Pgina: 11

Manejo de errores fError ()

Disponibilidad AdminPAQ 2002. Sintaxis fError(aNumError, aMensaje, aLen )

Parmetros Nombre Tipo Uso Descripcin aNumError Entero Por valor Nmero del error. aMensaje Cadena Por referencia Descripcin del error. aLen Entero Por valor Longitud del mensaje de error.

Retorna aMensaje: Al finalizar la funcin este parmetro contiene el mensaje de error correspondiente al nmero de error especificado en aNumError.

Descripcin Esta funcin recupera el mensaje de error del SDK.

Ejemplo El siguiente cdigo asigna a la variable lError el resultado de la funcin fInicializaSDK(), en caso de que suceda algn error (valor distinto de 0), la funcin fError se ejecuta obteniendo el mensaje correspondiente al nmero de error enviado, mostrando una longitud de mensaje de 350 caracteres.

lError = fInicializaSDK() If lError 0 Then fError lError, lMensaje, 350 End End If

Ver tambin fInicializaSDK (), fTerminaSDK ()

Pgina: 12

FUNCIONES DE EMPRESAS Navegacin fPosPrimerEmpresa ()


Sintaxis fPosPrimerEmpresa(aIdEmpresa, aNombreEmpresa, aDirectorioEmpresa )

Parmetros Nombre Tipo Uso Descripcin aIdEmpresa Entero Por referencia Identificador de la empresa. aNombreEmpresa Cadena Por referencia Nombre de la empresa. aDirectorioEmpresa Cadena Por referencia Directorio de la empresa.


aIdEmpresa: Al finalizar la funcin este parmetro contiene el identificador de la primera empresa registrada en la Base de Datos.

aNombreEmpresa: Al finalizar la funcin este parmetro contiene el nombre de la primera empresa registrada en la Base de Datos. aDirectorioEmpresa: Al finalizar la funcin este parmetro contiene el directorio de la primera empresa registrada en la base de datos.

Descripcin Esta funcin se posiciona en el primer registro de la base de datos de empresas de AdminPAQ, modifica los parmetros aNombreEmpresa y aDirectorioEmpresa, en los cuales guarda el nombre de la primera empresa y su ruta, correspondientemente.

Ejemplo El siguiente cdigo indica a la aplicacin que se posicione en el primer registro de empresas de la base de datos de AdminPAQ.

fPosPrimerEmpresa(lIdEmpresa, lNombreEmpresa, lDirectorioEmpresa)

Ver tambin fPosSiguienteEmpresa (), fAbreEmpresa (), fCierraEmpresa ()

Pgina: 13

fPosSiguienteEmpresa () Disponibilidad AdminPAQ 2002. Sintaxis fPosSiguienteEmpresa (aIdEmpresa, aNombreEmpresa, aDirectorioEmpresa )

Parmetros Nombre Tipo Uso Descripcin aIdEmpresa Entero Por referencia Identificador de la empresa. aNombreEmpresa Cadena Por referencia Nombre de la empresa. aDirectorioEmpresa Cadena Por referencia Directorio de la empresa.


aIdEmpresa: Al finalizar la funcin este parmetro contiene el identificador de la siguiente empresa registrada en la Base de Datos. aNombreEmpresa: Al finalizar la funcin este parmetro contiene el nombre de la siguiente empresa registrada en la base de datos. aDirectorioEmpresa: Al finalizar la funcin este parmetro contiene el directorio de la siguiente empresa registrada en la base de datos.

Descripcin Esta funcin avanza al siguiente registro en la tabla de Empresas de AdminPAQ; en caso de que no exista un siguiente registro, la funcin retorna un valor distinto de 0 (cero).

Ejemplo El siguiente cdigo termina el SDK de AdminPAQ.

fPosSiguienteEmpresa (lIdEmpresa, lNombreEmpresa, lDirectorioEmpresa )

Ver tambin fPosPrimerEmpresa (), fAbreEmpresa (), fCierraEmpresa ()

Pgina: 14

Apertura / Cierre fAbreEmpresa ()

Disponibilidad AdminPAQ 2002. Sintaxis fAbreEmpresa (aDirectorioEmpresa )

Parmetros Nombre Tipo Uso Descripcin aDirectorioEmpresa Cadena Por valor Directorio de la empresa.


Descripcin Esta funcin abre la empresa que corresponde a la ruta especificada en el parmetro aDirectorioEmpresa.

Ejemplo El siguiente cdigo indica a la aplicacin que abra la empresa ubicada el la ruta C:\Compacw\Empresas\EmpresaEjemplo.

lDirectorioEmpresa = C:\Compacw\Empresas\EmpresaEjemplo fAbreEmpresa (lDirectorioEmpresa)

Ver tambin fPosPrimerEmpresa (), fPosSiguienteEmpresa (), fCierraEmpresa (),fInicializaSDK (), fTerminaSDK ()

fCierraEmpresa ()

Disponibilidad AdminPAQ 2002. Sintaxis fCierraEmpresa ()

Parmetros No usa.

Retorna No tiene valor de retorno.

Descripcin Cierra la conexin con la empresa activa en la aplicacin que usa el SDK.

Ejemplo El siguiente cdigo cierra la empresa activa.

fCierraEmpresa()

Ver tambin fPosPrimerEmpresa (), fPosSiguienteEmpresa (), fAbreEmpresa (),fInicializaSDK (), fTerminaSDK ()

Pgina: 15

FUNCIONES DE DOCUMENTOS Bajo Nivel Lectura/Escritura fInsertarDocumento ()

Disponibilidad AdminPAQ 2002. Sintaxis fInsertarDocumento ()

Parmetros No usa.

Retorna Valores enteros: kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito. !kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error

Descripcin Adiciona un nuevo registro en la tabla de Documentos en modo de insercin.

Ejemplo El siguiente cdigo indica a la aplicacin que inserte un nuevo registro en la tabla de Documentos.

fInsertarDocumento ()

Ver tambin fEditarDocumento (), fGuardaDocumento (), fBorraDocumento (), fAfectaDocto_Param (), fCancelarModificacionDocumento (),fCancelaDocumento (), fSaldarDocumento_Param (), fBorrarAsociacion_Param (), fSetDatoDocumento (), fLeeDatoDocumento (), fSiguienteFolio (), fSetFiltroDocumento (), fCancelaFiltroDocumento (), fBuscarDocumento (), fBuscarIdDocumento (), fAltaDocumento (), fAltaDocumentoCargoAbono (), fAfectaDocto (), fSaldarDocumento (),fBuscaDocumento ()

Pgina: 16

fEditarDocumento () Disponibilidad AdminPAQ 2002.

Sintaxis fEditarDocumento ()

Parmetros No usa.


Descripcin Activa el modo de Edicin de un registro en la tabla de Documentos.

Ejemplo El siguiente cdigo busca un documento por su llave, si lo encuentra lo activa en modo edicin, en caso de no encontrarlo enva el mensaje de error correspondiente

lError = fBuscaDocumento(lLlaveDocto ) If lError 0 Then MensajeError lError Else fEditarDocumento () End If

Ver tambin fInsertarDocumento (), fGuardaDocumento (), fBorraDocumento (), fCancelarModificacionDocumento (),fCancelaDocumento (), fSetDatoDocumento (), fLeeDatoDocumento (), fSiguienteFolio (), fSetFiltroDocumento (), fCancelaFiltroDocumento (), fDocumentoImpreso (), fBuscarDocumento (), fAltaDocumento (), fAfectaDocto (), fSaldarDocumento (), fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fRegresaIVACargo (), fRegresaIVAPago (), fBuscaDocumento ()

Pgina: 17

fGuardaDocumento () Disponibilidad AdminPAQ 2002. Sintaxis fInsertarDocumento ()

Parmetros No usa.


Descripcin Guarda los cambios realizados a un documento.

Ejemplo El siguiente cdigo indica a la aplicacin que guarde los cambios al documento activo. Esta funcin se llama despus de que se utiliza la funcin fInsertarDocumento() o fEditarDocumento y se graban los valores en los campos correspondientes.

fGuardaDocumento ()

Ver tambin fInsertarDocumento (), fEditarDocumento (), fBorraDocumento(),fCancelaDocumento (),fCancelarModificacionDocumento (), fSetDatoDocumento (), fLeeDatoDocumento (), fSetFiltroDocumento (), fCancelaFiltroDocumento (), fAltaDocumento (), fAltaDocumentoCargoAbono (),fAfectaDocto_Param (), fAfectaDocto (), fSaldarDocumento (), fBorrarAsociacion (), fRegresaIVACargo (), fRegresaIVAPago (), fBuscaDocumento ()

Pgina: 18

fCancelarModificacionDocumento () Disponibilidad AdminPAQ 2002. Sintaxis fCancelarModificacionDocumento ()

Parmetros No usa.


Descripcin Esta funcin cancela las modificaciones al registro actual de documentos. El registro debe estar en modo de edicin o insercin.

Ejemplo El siguiente cdigo indica a la aplicacin que cancele la modificacin a un registro de documentos que estaba en modo de insercin o edicin.

fCancelarModificacionDocumento ()

Ver tambin fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (), fBorraDocumento (), fCancelaDocumento () ,fSetDatoDocumento (), fLeeDatoDocumento (), fSiguienteFolio (), fBuscarDocumento (), fAltaDocumento (), fAltaDocumentoCargoAbono (), fAfectaDocto (), fSaldarDocumento (), fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fRegresaIVACargo (), fRegresaIVAPago (), fBuscaDocumento ()

Pgina: 19

fBorraDocumento () Disponibilidad AdminPAQ 2002.

Sintaxis fBorraDocumento ()

Parmetros No usa.


Descripcin Borra un registro en la tabla de Documentos. Ejemplo El siguiente cdigo busca un documento por su llave, si lo encuentra lo borra, en caso

contrario enva el mensaje de error correspondiente

lError = fBuscaDocumento(lLlaveDocto ) If lError 0 Then MensajeError lError Else fBorraDocumento () End If

Ver tambin fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (), fCancelarModificacionDocumento (),fCancelaDocumento (), fSetDatoDocumento (), fLeeDatoDocumento (), fBuscarDocumento (), fBuscaDocumento ()

Pgina: 20

fCancelaDocumento () Disponibilidad AdminPAQ 2006 v. 3.2.2. Sintaxis fCancelaDocumento ()

Parmetros No usa. Retorna Valores enteros:

kSIN_ERRORES = 0 (cero) La operacin fue realizada con xito. !kSIN_ERRORES = Diferente de 0 (cero) Cdigo del error.

Descripcin Esta funcin cancela documentos de AdminPAQ.

Ejemplo El siguiente cdigo indica a la aplicacin que cancele la modificacin a un registro de documentos que estaba en modo de insercin o edicin.

lError = fBuscaDocumento(lLlaveDocto ) If lError 0 Then MensajeError lError Else fCancelaDocumento () End If

Ver tambin fCancelaDocumento (), fCancelaDocumento_CW (), fAfectaDocto_Param (), fSaldarDocumento_Param (), fBorrarAsociacion_Param (), fBuscarDocumento (), fBuscarIdDocumento (), fAfectaDocto (), fSaldarDocumento (), fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fBuscaDocumento ()

Pgina: 21

fBorraDocumento_CW () Disponibilidad AdminPAQ 2005.

Sintaxis fBorraDocumento_CW () Parmetros No usa.


Descripcin Borra un documento de AdminPAQ y si este estuviera contabilizacin tambin borra la pliza correspondiente en ContPAQ.

Ejemplo El siguiente cdigo busca un documento por su llave, si lo encuentra lo borra, en caso contrario enva el mensaje de error correspondiente.

lError = fBuscaDocumento(lLlaveDocto ) If lError 0 Then MensajeError lError Else fBorraDocumento_CW () End If

Ver tambin fGuardaDocumento (), fBorraDocumento (), fCancelarModificacionDocumento (),fBorraDocumento_CW (), fBuscarDocumento (), fBuscarIdDocumento (),fAltaDocumento (), fAltaDocumentoCargoAbono (), fBorrarAsociacion (), fBuscaDocumento ()

Pgina: 22

fCancelaDocumento_CW () Disponibilidad AdminPAQ 2006 v. 3.2.2. Sintaxis fCancelaDocumento ()

Parmetros No usa.


Descripcin Esta funcin cancela un documento de AdminPAQ y borra la poliza correspondiente en ContPAQ.

Ejemplo El siguiente cdigo busca un documento por su llave, si lo encuentra lo cancela, en caso contrario enva el mensaje de error correspondiente.

lError = fBuscaDocumento(lLlaveDocto ) If lError 0 Then MensajeError lError Else fCancelaDocumento () End If

Ver tambin fCancelaDocumento_CW (), fAfectaDocto_Param (), fSaldarDocumento_Param (), fBorrarAsociacion_Param (), fBuscarDocumento (), fBuscarIdDocumento (), fAltaDocumento (), fAltaDocumentoCargoAbono (), fAfectaDocto (), fSaldarDocumento (), fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fBuscaDocumento ()

Pgina: 23

fAfectaDocto_Param () Disponibilidad AdminPAQ 2005. Sintaxis fAfectaDocto (aCodConcepto, aSerie, aFolio, aAfecta)

Parmetros Nombre Tipo Uso Descripcin aCodConcepto Cadena Por valor Cdigo del concepto del

documento. aSerie Cadena Por valor Serie del documento aFolio Doble Por valor Folio del documento aAfecta Lgico (Bool) Por valor Verdadero o falso.

Afectar o desafectar.


Descripcin Esta funcin utiliza aCodConcepto, aSerie, y aFolio como llave del documento y aAfecta para afectar o desafectarlo.

Ejemplo El siguiente cdigo indica a la aplicacin que de afecte un documento, en caso de presentarse algn error manda el mensaje correspondiente.

lError = fAfectaDocto (lCodConcepto, lSerie, lFolio, lAfecta) If lError 0 Then MensajeError lError Else

Ver tambin fCancelaDocumento (), fCancelaDocumento_CW (), fBuscarDocumento (), fAltaDocumento (), fAltaDocumentoCargoAbono (), fAfectaDocto (), fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fBuscaDocumento ()

Pgina: 24

fSaldarDocumento_Param () Disponibilidad AdminPAQ 2005. Sintaxis fSaldarDocumento_Param (aCodConcepto_Pagar, aSerie_Pagar, aFolio_Pagar

aCodConcepto_Pago, aSerie_Pago, aFolio_Pago, aImporte, aIdMoneda, aFecha)

Parmetros Nombre Tipo Uso Descripcin aCodConcepto_Pagar Cadena Por valor Cdigo del concepto del

documento a pagar. aSerie_Pagar Cadena Por valor Serie del documento a pagar. aFolio_Pagar Cadena Por valor Folio del documento a pagar. aCodConcepto_Pago Cadena Por valor Cdigo del concepto del

documento que paga. aSerie_Pago Cadena Por valor Serie del documento que

paga. aFolio_Pago Cadena Por valor Folio del documento que

paga. aImporte Doble Por valor Importe del pago. aIdMoneda Entero Por valor Moneda del pago. aFecha Cadena Por valor Fecha del pago.


Descripcin Esta funcin asocia documentos y salda sus importes.

Ejemplo El siguiente cdigo indica a la aplicacin que de salde un documento con la informacin enviada, en caso de presentarse algn error manda el mensaje correspondiente.

lError = fSaldarDocumento_Param (lCodConcepto_Pagar, lSerie_Pagar, lFolio_Pagar lCodConcepto_Pago, lSerie_Pago, lFolio_Pago, lImporte, lIdMoneda, lFecha) If lError 0 Then MensajeError lError Else

Ver tambin fBorrarAsociacion_Param (), fBuscarDocumento (), fBuscarIdDocumento (), fAltaDocumento (), fAltaDocumentoCargoAbono (), fAfectaDocto (), fSaldarDocumento (), fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fBuscaDocumento ()

Pgina: 25

fBorrarAsociacion_Param () Disponibilidad AdminPAQ 2005. Sintaxis fBorrarAsociacion (aCodConcepto_Pagar, aSerie_Pagar, aFolio_Pagar

aCodConcepto_Pago, aSerie_Pago, aFolio_Pago) Parmetros Nombre Tipo Uso Descripcin

aCodConcepto_Pagar Cadena Por valor Cdigo del concepto del documento pagado.

aSerie_Pagar Cadena Por valor Serie del documento pagado. aFolio_Pagar Cadena Por valor Folio del documento pagado. aCodConcepto_Pago Cadena Por valor Cdigo del concepto del

documento que pag. aSerie_Pago Cadena Por valor Serie del documento que

pag.. aFolio_Pago Cadena Por valor Folio del documento que

pag.


Descripcin Esta funcin la asociacin de documentos.

Ejemplo El siguiente cdigo indica a la aplicacin que elimine la asociacin entre el documento pagado y el que pag ; en caso de presentarse algn error manda el mensaje correspondiente.

lError = fBorrarAsociacion (lCodConcepto_Pagar, lSerie_Pagar, lFolio_Pagar lCodConcepto_Pago, lSerie_Pago, lFolio_Pago) If lError 0 Then MensajeError lError Else

Ver tambin fBuscarDocumento (), fAfectaDocto (), fSaldarDocumento (), fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fBuscaDocumento ()

Pgina: 26

fSetDatoDocumento () Disponibilidad AdminPAQ 2002. Sintaxis fSetDatoDocumento (aCampo, aValor)

Parmetros Nombre Tipo Uso Descripcin aCampo Cadena Por valor Campo destino aValor Cadena Por valor Valor de escritura


Descripcin Esta funcin escribe el valor indicado en el campo correspondiente en el registro activo de la tabla de documentos.

Ejemplo El siguiente cdigo indica a la aplicacin que busque un documento por su llave, en caso de que lo encuentre escribe el contenido de la variable lFecha en el campo cFecha de la tabla de documentos; en caso contrario muestra el mensaje de error correspondiente.

lError = fBuscaDocumento(lLlaveDocto ) If lError 0 Then MensajeError lError Else lError = fSetDatoDocumento("cFecha", lFecha) End If

Ver tambin fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (), fBorraDocumento (), fCancelarModificacionDocumento (), fLeeDatoDocumento (), fSiguienteFolio (), fSetFiltroDocumento (), fCancelaFiltroDocumento (), fBuscarDocumento (), fBuscarIdDocumento (), fAltaDocumento (), fAltaDocumentoCargoAbono (), fAfectaDocto (), fBuscaDocumento ()

Pgina: 27

fLeeDatoDocumento () Disponibilidad AdminPAQ 2002. Sintaxis fLeeDatoDocumento (aCampo, aValor)

Parmetros Nombre Tipo Uso Descripcin aCampo Cadena Por valor Campo destino aValor Cadena Por referencia Valor de escritura


aValor: Al finalizar la funcin este parmetro contiene el valor del campo especificado.

Descripcin Esta funcin lee el valor indicado del campo correspondiente en el registro activo de la tabla de documentos.

Ejemplo El siguiente cdigo indica a la aplicacin que busque un documento por su llave, en caso de que lo encuentre lee el contenido del campo cFecha de la tabla de documentos y lo asigna a la variable lFecha; en caso contrario muestra el mensaje de error correspondiente.

lError = fBuscaDocumento(lLlaveDocto ) If lError 0 Then MensajeError lError Else lError = fLeeDatoDocumento("cFecha", lFecha) End If

Ver tambin fSetDatoDocumento (), fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (),fBuscaDocumento () , fCancelarModificacionDocumento (), fSaldarDocumento_Param (), fSetFiltroDocumento (), fCancelaFiltroDocumento (), fBuscarDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento (), fRegresaIVACargo (), fRegresaIVAPago ()

Pgina: 28

fSiguienteFolio () Disponibilidad AdminPAQ 2002. Sintaxis fSiguienteFolio(aCodigoConcepto, aSerie, aFolio )

Parmetros Nombre Tipo Uso Descripcin aCodigoConcepto Cadena Por valor Cdigo del concepto del

documento. aSerie Cadena Por referencia Serie del documento aFolio Doble Por referencia Folio del documento


aSerie: Al finalizar la funcin este parmetro contiene el valor de la serie del documento especificado. aFolio: Al finalizar la funcin este parmetro contiene el siguiente folio del documento especificado.


Ejemplo El siguiente cdigo indica a la aplicacin que obtenga

lError = fSiguienteFolio(lCodigoConcepto, lSerie, lFolio )

Ver tambin fInsertarDocumento (), fEditarDocumento (), fLeeDatoDocumento (), fSetFiltroDocumento (), fCancelaFiltroDocumento (), fBuscarDocumento (), fBuscarIdDocumento (), fBuscaDocumento ()

Pgina: 29

fSetFiltroDocumento () Disponibilidad AdminPAQ 2002. Sintaxis fSetFiltroDocumento(aFechaInicio, aFechaFin, aCodigoConcepto, aCodigoCteProv)

Parmetros Nombre Tipo Uso Descripcin aFechaInicio Cadena Por valor Fecha inicial del rango. aFechaFin Cadena Por valor Fecha final del rango. aCodigoConcepto Cadena Por valor Cdigo del concepto a filtrar. aCodigoCteProv Cadena Por valor Cdigo del Cliente/Proveedor

a filtrar.


Descripcin Esta funcin aplica un filtro a los documentos de acuerdo a su cdigo y al cdigo del cliente/proveedor en un rango de fechas especificados.

Ejemplo El siguiente cdigo indica a la aplicacin que realice un filtro de documentos para el primer semestre del ao 2006, para el cdigo de concepto 4 y el cdigo de Cliente/Proveedor CTE002.

lFechaInicio = 01/01/2006 lFechaFin = 06/30/2006 lCodConcepto = 4" lCodCteProv = CTE002 lError = fSetFiltroDocumento (aCodigoConcepto, aSerie, aFolio )

Ver tambin fSetDatoDocumento (), fLeeDatoDocumento (), fSiguienteFolio (), fCancelaFiltroDocumento (), fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento (), fPosSiguienteDocumento (), fPosAnteriorDocumento (), fPosBOF (), fPosEOF (), fBuscaDocumento ()

Pgina: 30

fCancelaFiltroDocumento () Disponibilidad AdminPAQ 2002. Sintaxis fCancelaFiltroDocumento ()

Parmetros No usa.


Descripcin Esta funcin cancela el ultimo filtro activo de documentos.

Ejemplo El siguiente cdigo cancela el ultimo filtro activo de documentos.

fCancelaFiltroDocumento ()

Ver tambin fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (), fBorraDocumento (), fCancelarModificacionDocumento (), fSetFiltroDocumento (), fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento (), fPosSiguienteDocumento (), fPosAnteriorDocumento (), fBuscaDocumento ()

fDocumentoImpreso ()

Disponibilidad AdminPAQ 2003. Sintaxis fDocumentoImpreso (aImpreso) Parmetros Nombre Tipo Uso Descripcin

aImpreso Lgico (bool) Por referencia Valor lgico. Verdadero o Falso.

Retorna Valores enteros:


Descripcin Esta funcin cambia la bandera de documento impreso. Es necesario estar en el registro del documento que se quiere actualizar la bandera.

Ejemplo El siguiente cdigo indica a la aplicacin que cambie el estado de impresin del documento a Falso.

lImpreso = False lError = fDocumentoImpreso (lImpreso)

Ver tambin fBuscarDocumento (), fBuscarIdDocumento (), fBuscaDocumento (),fSetDatoDocumento (), fLeeDatoDocumento ()

Pgina: 31

Bajo Nivel Bsqueda/Navegacin fBuscarDocumento ()

Disponibilidad AdminPAQ 2002. Sintaxis fBuscarDocumento (aCodConcepto, aSerie, aFolio) Parmetros Nombre Tipo Uso Descripcin

aCodConcepto Cadena Por valor Cdigo del concepto del documento.

aSerie Cadena Por valor Serie del documento. aFolio Cadena Por valor Folio del documento.



Descripcin Esta funcin busca un documento por su llave, si lo encuentra se posiciona en el registro correspondiente.

Ejemplo El siguiente cdigo indica a la aplicacin que busque un documento por su cdigo de concepto, serie y folio.

lError = fBuscarDocumento (lLlaveDocto )

Ver tambin fCancelaDocumento (), fBorraDocumento_CW (), fCancelaDocumento_CW (), fAfectaDocto_Param (), fSaldarDocumento_Param (), fBuscarIdDocumento (), fBuscaDocumento ()

fBuscarIdDocumento ()

Disponibilidad AdminPAQ 2005. Sintaxis fBuscarIdDocumento (aIdDocumento)

Parmetros Nombre Tipo Uso Descripcin aIdDocumento Entero Por valor Identificador del documento.



Descripcin Esta funcin busca un documento por su identificador.

Ejemplo El siguiente cdigo busca un documento por su identificador.

fBuscarIdDocumento (lIdDocumento)

Ver tambin fCancelaDocumento (), fBorraDocumento_CW (), fCancelaDocumento_CW (), fAfectaDocto_Param (), fSaldarDocumento_Param (), fBorrarAsociacion_Param (), fBuscarDocumento (), fAfectaDocto (), fBuscaDocumento ()

Pgina: 32

fPosPrimerDocumento () Disponibilidad AdminPAQ 2002. Sintaxis fPosPrimerDocumento ()



Descripcin Esta funcin se ubica en el primer registro de la tabla de documentos.

Ejemplo El siguiente cdigo indica a la aplicacin que se posicione en el primer registro de la tabla de Documentos.

lError = fPosPrimerDocumento ()

Ver tambin fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento (), fPosSiguienteDocumento (), fPosAnteriorDocumento (), fPosBOF (), fPosEOF (), fBuscaDocumento ()

fPosUltimoDocumento ()

Disponibilidad AdminPAQ 2002. Sintaxis fPosUltimoDocumento ()

Parmetros No usa.


Descripcin Esta funcin se ubica en el ultimo registro de la tabla de documentos.

Ejemplo El siguiente cdigo indica a la aplicacin que se posicione en el ultimo registro de la tabla de Documentos.

lError = fPosPrimerDocumento ()

Ver tambin fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento (), fPosSiguienteDocumento (), fPosAnteriorDocumento (), fPosBOF (), fPosEOF () fBuscaDocumento ()

Pgina: 33

fPosSiguienteDocumento () Disponibilidad AdminPAQ 2002. Sintaxis fPosSiguienteDocumento ()



Descripcin Esta funcin se ubica en el siguiente registro de la posicin actual de la tabla de documentos.

Ejemplo El siguiente cdigo indica a la aplicacin que se posicione en el siguiente registro de la tabla de documentos.

lError = fPosSiguienteDocumento ()

Ver tambin fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento (), fPosAnteriorDocumento (), fPosBOF (), fPosEOF (), fBuscaDocumento ()

fPosAnteriorDocumento ()

Disponibilidad AdminPAQ 2002. Sintaxis fPosAnteriorDocumento ()

Parmetros No usa.


Descripcin Esta funcin se ubica en el registro anterior de la posicin actual de la tabla de documentos.

Ejemplo El siguiente cdigo indica a la aplicacin que se posicione en el registro anterior de la tabla de documentos.

lError = fPosAnteriorDocumento ()


Pgina: 34

fPosBOF () Disponibilidad AdminPAQ 2002. Sintaxis fPosBOF ()


1 (uno) Verdadero. 0 (cero) Falso.

Descripcin Informa si el registro activo se encuentra en el inicio de la tabla de Documentos

Ejemplo El siguiente cdigo indica a la aplicacin que asigne a la variable lInicioTablaDocto el resultado de la funcin fPosBOF.

lInicioTablaDocto = fPosBOF ()


fPosEOF ()

Disponibilidad AdminPAQ 2002. Sintaxis

fPosEOF ()



Descripcin Informa si el registro activo se encuentra en el fin de la tabla de Documentos

Ejemplo El siguiente cdigo indica a la aplicacin que asigne a la variable lFinTablaDocto el resultado de la funcin fPosEOF.

lFinTablaDocto = fPosEOF ()


Pgina: 35

Alto Nivel Lectura/Escritura fAltaDocumento ()

Disponibilidad AdminPAQ 2002. Sintaxis fAltaDocumento (aIdDocumento, aDocumento ) Parmetros Nombre Tipo Uso Descripcin

aIdDocumento Entero largo Por referencia Identificador del documento. aDocumento tDocumento Por valor Tipo de dato abstracto.


aIdDocumento: Al finalizar la funcin este parmetro contiene el identificador del nuevo documento.

Descripcin Esta funcin da de alta documentos de cargo o abono.

Ejemplo El siguiente cdigo indica a la aplicacin que de alta un documento, en caso de presentarse algn error manda el mensaje correspondiente.

lError = fAltaDocumento (lIdDocto, lDocumento) If lError 0 Then MensajeError lError Else

Ver tambin fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (), fBorraDocumento (), fCancelarModificacionDocumento (), fBuscarDocumento (), fBuscarIdDocumento (), fAltaDocumentoCargoAbono (), fAfectaDocto (), fBuscaDocumento ()

Pgina: 36

fAltaDocumentoCargoAbono () Disponibilidad AdminPAQ 2002. Sintaxis fAltaDocumentoCargoAbono (aDocumento)

Parmetros Nombre Tipo Uso Descripcin aDocumento tDocumento Por valor Tipo de dato abstracto.


Descripcin Esta funcin da de alta documentos de cargo o abono.

Ejemplo El siguiente cdigo indica a la aplicacin que de alta un documento de cargo/abono, en caso de presentarse algn error manda el mensaje correspondiente.

lError = fAltaDocumentoCargoAbono (lDocumento) If lError 0 Then MensajeError lError Else

Ver tambin fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (), fAfectaDocto_Param (), fSaldarDocumento_Param (), fBuscarDocumento (), fBuscarIdDocumento (), fAltaDocumento (), fAfectaDocto (), fSaldarDocumento (), fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fRegresaIVACargo (), fRegresaIVAPago (), fBuscaDocumento ()

Pgina: 37

fAfectaDocto () Disponibilidad AdminPAQ 2002. Sintaxis fAfectaDocto (aLlaveDocto, aAfecta)

Parmetros Nombre Tipo Uso Descripcin aLlaveDocto tLlaveDocto Por valor Tipo de dato abstracto. aAfecta Lgico (Bool) Por valor Verdadero o falso. Afectar o

desafectar.


Descripcin Esta funcin utiliza aLlaveDocto como llave del documento y aAfecta para afectar o desafectarlo.

Ejemplo El siguiente cdigo indica a la aplicacin que de afecte un documento, en caso de presentarse algn error manda el mensaje correspondiente.

lError = fAfectaDocto (lDocumento, True) If lError 0 Then MensajeError lError Else

Ver tambin fCancelaDocumento (), fBorraDocumento_CW (), fCancelaDocumento_CW (), fAfectaDocto_Param (), fSaldarDocumento_Param (), fBorrarAsociacion_Param (), fBuscarDocumento (), fBuscarIdDocumento (), fAltaDocumento (), fAltaDocumentoCargoAbono (), fAfectaDocto (), fSaldarDocumento (), fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fBuscaDocumento ()

Pgina: 38

fSaldarDocumento () Disponibilidad AdminPAQ 2002. Sintaxis fSaldarDocumento (aDoctoaPagar, aDoctoPago, aImporte, aIdMoneda, aFecha)

Parmetros Nombre Tipo Uso Descripcin aDoctoaPagar tLlaveDocto Por valor Tipo de dato abstracto. aDoctoPago tLlaveDocto Por valor Tipo de dato abstracto. aImporte Doble Por valor Importe del pago. aIdMoneda Entero Por valor Moneda del pago. aFecha Cadena Por valor Fecha del pago.



Ejemplo El siguiente cdigo indica a la aplicacin que de salde un documento con la informacin enviada, en caso de presentarse algn error manda el mensaje correspondiente.

lError = fSaldarDocumento (lDoctoaPagar, lDoctoPago, lImporte, lIdMoneda, lFecha) If lError 0 Then MensajeError lError Else

Ver tambin fInsertarDocumento (), fEditarDocumento (), fGuardaDocumento (), fBorraDocumento (), fCancelarModificacionDocumento (),fCancelaDocumento (), fBorraDocumento_CW (), fCancelaDocumento_CW (), fAfectaDocto_Param (), fSaldarDocumento_Param (), fBorrarAsociacion_Param (), fSetDatoDocumento (), fLeeDatoDocumento (), fSiguienteFolio (), fSetFiltroDocumento (), fCancelaFiltroDocumento (), fDocumentoImpreso (), fBuscarDocumento (), fBuscarIdDocumento (), fPosPrimerDocumento (), fPosUltimoDocumento (), fPosSiguienteDocumento (), fPosAnteriorDocumento (), fPosBOF (), fPosEOF (), fAltaDocumento (), fAltaDocumentoCargoAbono (), fAfectaDocto (), fSaldarDocumento (), fSaldarDocumentoCheqPAQ (), fBorrarAsociacion (), fRegresaIVACargo (), fRegresaIVAPago (), fBuscaDocumento ()

Pgina: 39

fSaldarDocumentoCheqPAQ () Disponibilidad AdminPAQ 2004. Sintaxis fSaldarDocumentoCheqPAQ (aDoctoaPagar, aDoctoPago, aImporte, aIdMoneda, aFecha,

aTipoCambioCheqPAQ) Parmetros Nombre Tipo Uso Descripcin

aDoctoaPagar tLlaveDocto Por valor Tipo de dato abstracto. aDoctoPago tLlaveDocto Por valor Tipo de dato abstracto. aImporte Doble Por valor Importe del pago. aIdMoneda Entero Por valor Moneda del pago. aFecha Cadena Por valor Fecha del pago. aTipoCambioCheqPAQ Doble Por valor Tipo de cambio de la moneda

extranjera que interviene en el cargo-abono del da de pago.



Ejemplo El siguiente cdigo indica a la aplicacin que de salde un documento con el documento correspondiente en CheqPAQ usando el tipo de cambio del da de pago; en caso de presentarse algn error manda el mensaje correspondiente.

lError = fSaldarDocumentoCheqPAQ (lDoctoaPagar, lDoctoPago, lImporte, lIdMoneda, lFecha) If lError 0 Then MensajeError lError Else


Pgina: 40

fBorrarAsociacion () Disponibilidad AdminPAQ 2002. Sintaxis fBorrarAsociacion (aDoctoaPagar, aDoctoPago)

Parmetros Nombre Tipo Uso Descripcin aDoctoaPagar tLlaveDocto Por valor Tipo de dato abstracto. aDoctoPago tLlaveDocto Por valor Tipo de dato abstracto. aImporte Doble Por valor Importe del pago. aIdMoneda Entero Por valor Moneda del pago. aFecha Cadena Por valor Fecha del pago. aTipoCambioCheqPAQ Doble Por valor Tipo de cambio de la moneda

extranjera que interviene en el cargo-abono del da de pago.


Descripcin Esta funcin la asociacin de documentos.

Ejemplo El siguiente cdigo indica a la aplicacin que elimine la asociacin entre lDoctoaPagar y lDoctoPago ; en caso de presentarse algn error manda el mensaje correspondiente.

lError = fBorrarAsociacion (lDoctoaPagar, lDoctoPago) If lError 0 Then MensajeError lError Else


Pgina: 41

fRegresaIVACargo () Disponibilidad AdminPAQ 2002. Sintaxis fRegresaIVACargo (aLlaveDocto, aNetoTasa15, aNetoTasa10, aNetoTasaCero,

aNetoTasaExcenta, aNetoOtrasTasas, aIVATasa15, aIVATasa10, aIVAOtrasTasas)

Parmetros Nombre Tipo Uso Descripcin aLlaveDocto tLlaveDocto Por valor Tipo de dato abstracto. aNetoTasa15 Doble Por referencia Base de la tasa de 15% aNetoTasa10 Doble Por referencia Base de la tasa de 10% aNetoTasaCero Doble Por referencia Base de la tasa cero aNetoTasaExcenta Doble Por referencia Base de productos exentos aNetoOtrasTasas Doble Por referencia Base de otras tasas aIVATasa15 Doble Por referencia IVA de la tasa de 15% aIVATasa10 Doble Por referencia IVA de la tasa de 10% aIVAOtrasTasas Doble Por referencia IVA de otras tasas


Descripcin Esta funcin regresa el desglose de IVA de un documento.

Ejemplo El siguiente cdigo indica a la aplicacin que obtenga el desglose del IVA del documento especificado en el parmetro lLlaveDocto y que regrese los valores correspondientes a los parmetros por valor especificados.

lError = fRegresaIVACargo (lLlaveDocto, lNetoTasa15, lNetoTasa10, lNetoTasaCero, lNetoTasaExcenta, lNetoOtrasTasas, lIVATasa15, lIVATasa10, lIVAOtrasTasas)


Pgina: 42

fGetTamSelloDigitalYCadena () Disponibilidad AdminPAQ 2007. Versin 4.1.4 Sintaxis fGetTamSelloDigitalYCadena (atPtrPassword, aEspSelloDig, aEspCadOrig)

Parmetros Nombre Tipo Uso Descripcin

atPtrPassword Cadena Por referencia Contrasea del certificado. aEspSelloDig Entero Por referencia Tamao del Sello digital. aEspCadOrig Entero Por referencia Tamao de la Cadena original.


Descripcin Con esta funcin se obtiene el tamao de la cadena original y el sello digital, mismas que se guardarn en las variables aEspSelloDig y aEspCadOrig.

Ejemplo En el siguiente cdigo se pasa como parmetro la contrasea del certificado almacenada en la variable lPassword e indica a la aplicacin que obtenga el tamao del sello digital y cadena original del documento, recibindolos en las variables lEspSello y lEspSello.

lError = fGetTamSelloDigitalYCadena (lPassword, lEspSello, lEspCadOrig)

Ver tambin fGetSelloDigitalYCadena()

Pgina: 43

fGetSelloDigitalYCadena () Disponibilidad AdminPAQ 2007. Versin 4.1.4 Sintaxis fGetSelloDigitalYCadena (char *atPtrPassword, char* atPtrSelloDigital, char*

atPtrCadenaOriginal)

Parmetros Nombre Tipo Uso Descripcin atPtrPassword Cadena Por referencia Contrasea del certificado. atPtrSelloDigital Cadena Por referencia Sello digital. atPtrCadenaOriginal Cadena Por referencia Cadena original.


Descripcin Con esta funcin se obtiene el sello digital y la cadena original de un CFD.

Ejemplo En el siguiente cdigo se pasa como parmetro la contrasea del certificado almacenada en la variable lPassword e indica a la aplicacin que obtenga el tamao del sello digital y cadena original del documento, recibindolos en las variables lEspSello y lEspSello.

lError = fGetSelloDigitalYCadena (lPassword, lEspSello, lEspCadOrig)

Ver tambin fGetTamSelloDigitalYCadena()

Pgina: 44

fInicializaLicenseInfo() Disponibilidad AdminPAQ 2011. Versin 6.2.1 Sintaxis fInicializaLicenseInfo (aSistema)


aSistema Unsigned char Por valor Sistema: 0 = AdminPAQ 1 = CONTPAQ i Factura Electrnica

Retorna Valores enteros: kSIN_ERRORES = 0 (cero) que significa que se pudo conectar y obtener informacin del Servidor de Licencias, aunque la verificacin del nmero de usuarios se hace hasta el uso de la funcin fEmitirDocumento. !kSIN_ERRORES = -1 que significa que hubo un error al intentar obtener informacin del Servidor de Licencias del sistema especificado.

Descripcin Esta funcin verifica que el sistema est activado y tenga una licencia vlida.

Ejemplo En el siguiente cdigo pasa como parmetro un 0 indicando que se trata del sistema AdminPAQ para saber si el sistema est activado.

lError = fInicializaLicenseInfo (0)

Ver tambin fEmitirDocumento()

Pgina: 45

fEmitirDocumento () Disponibilidad AdminPAQ 2011. Versin 6.2.1 Sintaxis fEmitirDocumento (aCodConcepto, aSerie, aFolio, aPassword, aArchivoAdicional)


aCodConcepto Cadena Por referencia Cdigo del concepto aSerie Cadena Por referencia Serie del documento aFolio Doble Por valor Folio del documento aPassword Cadena Por referencia Contrasea del certificado de

sello digital aArchivoAdicional Cadena Por referencia Nombre del archivo con el

complemento, este archivo ya debe existir en la carpeta Adicionales dentro de la empresa.

Retorna Valores enteros: kSIN_ERRORES = 0 (cero) si no hubo error. !kSIN_ERRORES = -1 -1 que significa que hubo un error con la Licencia (la licencia es para menos de 10 usuarios, es temporal, de evaluacin, no est activada, etc.) !kSIN_ERRORES = Un nmero de error positivo del que se puede obtener la descripcin con la funcin fError.

Descripcin Para poder utilizar la funcin fEmitirDocumento, se deber ejecutar primero la funcin fInicializaLicenseInfo. La funcin fEmitirDocumento recibe como parmetro el nombre de un archivo el cual contiene un complemento que se insertar al CFD/CFDI al emitirse. Se debe tener una licencia para por lo menos 10 usuarios de AdminPAQ o CONTPAQ i Factura Electrnica. Esta funcin solo soporta los divisas, EstadoDeCuentaBancario, EstadoDeCuentaCombustible, PrestadoresDeServiciosDeCFD y la combinacion de estos.

Ejemplo La siguiente funcin emite un documento, pasando como parmetros el cdigo = 1001, serie=CFDI, folio = 154 del concepto, contrasea del certificado a0123456789, y nombre del archivo complemento divisas.xml.

lError = fEmitirDocumento("1001", "CFDI", 154, "a0123456789", "divisas.xml")

Ver tambin fInicializaLicenseInfo()

Pgina: 46

fDocumentoUUID() Disponibilidad AdminPAQ 2011. Versin 6.2.3 Sintaxis fDocumentoUUID (aCodigoConcepto, aSerie, aFolio, atPtrCFDIUUID)


aCodConcepto Cadena Por referencia Cdigo del concepto aSerie Cadena Por referencia Serie del documento aFolio Doble Por valor Folio del documento atPtrCFDIUUID Cadena Por referencia Cadena para colocar el valor

de UUID


Descripcin Esta funcin despliega el UUID de un documento.

Ejemplo En el siguiente cdigo se pasan el cdigo, serie y folio del concepto para recibir el UUID en la variable lUUID.

lError = fDocumentoUUID (lConcepto, lSerie, lFolio, lUUID)

fGetSerieCertificado ()

Disponibilidad AdminPAQ 2007. Versin 4.3.1 Sintaxis fGetSerieCertificado (atPtrPassword, aPtrSerieCertificado)


atPtrPassword Cadena Por referencia Contrasea del certificado aPtrSerieCertificado Cadena Por referencia Serie del certificado


Descripcin Esta funcin regresa la serie de un Certificado utilizado por una factura electrnica.

fActivarPrecioCompra ()

Disponibilidad AdminPAQ 2007. Versin 4.3.2 Sintaxis fActivarPrecioCompra (aActivar)


aActivar Entero Por valor 0 = No busca el precio 1 = Valor asumido (busca el precio)


Descripcin Esta funcin determina si al momento de registrar una compra va SDK se ejecutar la funcin que busca el ltimo precio de compra registrado en caso de que el precio sea igual a cero.

Pgina: 47

fDocumentoDevuelto () Disponibilidad AdminPAQ 2007. Versin 4.3.2 Sintaxis fDocumentoDevuelto (aDevuelto)


aDevuelto Entero Por valor 0 = No devuelto 1 = Devuelto


Descripcin Esta funcin ajusta el estado de un documento en devuelto o no devuelto.

fEntregEnDiscoXML ()

Disponibilidad AdminPAQ 2011. Versin 7.0.0 Sintaxis fEntregEnDiscoXML (aCodConcepto, aSerie, aFolio, aFormato, aFormatoAmig)


aCodConcepto Cadena Por referencia Cdigo del concepto aSerie Cadena Por referencia Serie del documento aFolio Doble Por valor Folio del documento aFormato Entero Por valor Formato de entrega (0 = XML, 1

= PDF) Nota: Al seleccionar la opcin de entrega 1= PDF, por disposicin fiscal tambin se generar el XML.

aFormatoAmig Cadena Por referencia Plantilla de impresin


Descripcin Esta funcin entrega el XML en un archivo.

Ejemplo En el siguiente ejemplo, se entrega el XML del concepto 4 (factura), Serie B1, folio 45, en formato PDF, en la ruta C:\Compacw\Empresas\Reportes\AdminPAQ\Plantilla_Factura_cfdi_1.html

lError = fEntregEnDiscoXML (4, B1, 45, 1, C:\Compacw\Empresas\Reportes\AdminPAQ\Plantilla_Factura_cfdi_1.html)

Pgina: 48

fObtieneDatosCFDI () Disponibilidad AdminPAQ 2012. Versin 7.2.0 Sintaxis fObtieneDatosCFDI (atPtrPassword)


atPtrPassword Cadena Por referencia Contrasea del certificado


Descripcin La funcin fObtieneDatosCFDI obtiene los datos del CFDI del documento previamente definido con la funcin fBuscarDocumento. Esta funcin almacena en variables globales los datos del CFDI dentro del mismo SDK para posteriormente ser ledos con la funcin fLeeDatoCFDI.

Ejemplo El siguiente ejemplo obtiene los datos del CFDI previamente ubicado con la funcin fBuscarDocumento pasando como parmetro la contrasea del certificado en la variable lPassword.

lError = fObtieneDatosCFDI(lPassword)

Ver tambin fBuscarDocumento(), fLeeDatoCFDI()

Pgina: 49

fLeeDatoCFDI () Disponibilidad AdminPAQ 2012. Versin 7.2.0 Sintaxis fLeeDatoCFDI (aValor, aDato)


aValor Cadena Por referencia Cadena donde se regresar el dato requerido

aDato Entero Por valor 1 = Serie del Certificado del Emisor 2 = Folio Fiscal (UUID) 3 = Nmero de Serie del Certificado del SAT 4 = Fecha y Hora de Certificacin 5 = Sello Digital del CFDI 6 = Sello SAT 7 = Cadena Original del Complemento de Certificacin Digital del SAT 8 = Mtodo de Pago 9 = Lugar de expedicin 10 = Rgimen Fiscal 11 = Folio Fiscal de origen* 12 = Serie del Folio Fiscal de origen* 13 = Fecha del Folio Fiscal de origen* 14 = Monto del Folio Fiscal de origen* * Para documentacin de Deuda o Pago en Parcialidades


Descripcin La funcin fLeeDatoCFDI lee los datos previamente accedidos con la funcin fObtieneDatosCFDI. La funcin recibe como parmetros, la cadena donde copiar el dato requerido y un entero donde se indica qu dato se desea y regresar un nmero de error en caso de existir alguno.

Ejemplo El siguiente ejemplo el UUID de un documento y lo almacena en la variable lUUID.

lError = fLeeDatoCFDI (lUUID, 2)

Ver tambin fBuscarDocumento(), fObtieneDatosCFDI()

Pgina: 50

Alto Nivel Bsqueda/Navegacin fBuscaDocumento ()

Disponibilidad AdminPAQ 2002. Sintaxis fBuscaDocumento (aLlaveDocto) Parmetros Nombre Tipo Uso Descripcin

aLlaveDocto tLlaveDocto Por valor Tipo de dato abstracto.


Descripcin Esta funcin busca un documento por su llave, si lo encuentra se posiciona en el registro correspondiente.

Ejemplo El siguiente cdigo indica a la aplicacin que busque el documento cuya llave es el contenido del parmetro lLlaveDocto.

lError = fBuscaDocumento (lLlaveDocto )


Pgina: 51

Funciones de Movimientos Bajo Nivel Lectura/Escritura fInsertarMovimiento ()

Disponibilidad AdminPAQ 2002. Sintaxis fInsertarMovimiento ()

Parmetros No usa.


Descripcin Adiciona un nuevo registro en la tabla de Movimientos en modo de insercin.

Ejemplo El siguiente cdigo indica a la aplicacin que inserte un nuevo registro en la tabla de Movimientos.

fInsertarMovimiento ()

Ver tambin fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(), fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fEditarMovimiento ()


Sintaxis fEditarMovimiento ()

Parmetros No usa.


Descripcin Activa el modo de Edicin de un registro en la tabla de Movimientos.

Ejemplo El siguiente cdigo busca un movimiento por su Identificador, si lo encuentra lo activa en modo edicin, en caso de no encontrarlo enva el mensaje de error correspondiente

lError = fBuscarIdMovimiento (lIdMovto) If lError 0 Then MensajeError lError Else fEditarMovimiento () End If

Ver tambin fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(), fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 52

fGuardaMovimiento () Disponibilidad AdminPAQ 2002. Sintaxis fGuardaMovimiento ()

Parmetros No usa.


Descripcin Guarda los cambios realizados a un movimiento.

Ejemplo El siguiente cdigo indica a la aplicacin que guarde cierto registro en la tabla de Documentos. Esta funcin se llama despus de que se utiliza la funcin fInsertarMovimiento() o fEditarMovimiento() y se graban los valores en los campos correspondientes.

fGuardaMovimiento ()


fCancelaCambiosMovimiento ()

Disponibilidad AdminPAQ 2002. Sintaxis fCancelaCambiosMovimiento ()

Parmetros No usa.


Descripcin Esta funcin cancela las modificaciones al registro actual de movimientos. El registro debe estar en modo de edicin o insercin.

Ejemplo El siguiente cdigo indica a la aplicacin que cancele la modificacin a un registro de Movimientos que estaba en modo de insercin o edicin.

fCancelaCambiosMovimiento ()


Pgina: 53

fAltaMovimientoCaracteristicas_Param () Disponibilidad AdminPAQ 2003. Sintaxis fAltaMovimientoCaracteristicas_Param (aIdMovimiento, aIdMovtoCaracteristicas, aUnidades,

aValorCaracteristica1, aValorCaracteristica2, aValorCaracteristica3)

Parmetros Nombre Tipo Uso Descripcin aIdMovimiento Cadena Por valor Identificador del movimiento. aIdMovtoCaracteristicas Cadena Por valor Identificador del movimiento

con caractersticas. aUnidades Cadena Por valor Unidades. aValorCaracteristica1 Cadena Por valor Valor de la caracterstica 1. aValorCaracteristica2 Cadena Por valor Valor de la caracterstica 2. aValorCaracteristica3 Cadena Por valor Valor de la caracterstica 3.


Descripcin Esta funcin inserta un movimiento con caractersticas.

Ejemplo El siguiente cdigo indica a la aplicacin que inserte un movimiento con caractersticas en la base de datos, en caso de que ocurra un error muestra el mensaje de error correspondiente.

lError = fAltaMovimientoCaracteristicas_Param ("lIdMovimiento, lIdMovtoCaracteristicas, lUnidades, lValorCaracteristica1, lValorCaracteristica2, lValorCaracteristica3)

If lError 0 Then MensajeError lError Else


Pgina: 54

fAltaMovtoCaracteristicasUnidades_Param () Disponibilidad AdminPAQ 2005. Sintaxis fAltaMovtoCaracteristicasUnidades_Param (aIdMovimiento, aIdMovtoCaracteristicas,

aUnidad, aUnidades, aUnidadesNC, aValorCaracteristica1, aValorCaracteristica2, aValorCaracteristica3)

Parmetros Nombre Tipo Uso Descripcin aIdMovimiento Cadena Por valor Identificador del movimiento. aIdMovtoCaracteristicas Cadena Por valor Identificador del movimiento

con caractersticas. aUnidad Cadena Por valor Abreviatura de la unidad de

compra venta aUnidades Cadena Por valor Las unidades del movimiento

de caractersticas. aUnidadesNC Cadena Por valor Abreviatura de la unidad de

compra venta no convertible.

aValorCaracteristica1 Cadena Por valor Valor de la caracterstica 1. aValorCaracteristica2 Cadena Por valor Valor de la caracterstica 2. aValorCaracteristica3 Cadena Por valor Valor de la caracterstica 3.



Descripcin Esta funcin da de alta movimiento de caractersticas con unidades de compra venta.

Ejemplo El siguiente da de alta movimiento de caractersticas con unidades de compra venta.

fAltaMovtoCaracteristicasUnidades_Param (lIdDocumento, lIdMovimiento, lMovimiento)


Pgina: 55

fAltaMovimientoSeriesCapas_Param () Disponibilidad AdminPAQ 2003. Sintaxis fAltaMovimientoSeriesCapas _Param (aIdMovimiento, aUnidades, aTipoCambio, aSeries,

aPedimento, aAgencia, aFechaPedimento, aNumeroLote, aFechaFabricacion, aFechaCaducidad)

Parmetros Nombre Tipo Uso Descripcin aIdMovimiento Cadena Por valor Identificador del movimiento. aUnidades Cadena Por valor Unidad de peso y medida. aTipoCambio Cadena Por valor Tipo de cambio. aSeries Cadena Por valor Series. aPedimento Cadena Por valor Referencia del pedimento. aAgencia Cadena Por valor Referencia de la agencia. aFechaPedimento Cadena Por valor Fecha del pedimento. aNumeroLote Cadena Por valor Nmero de lote. aFechaFabricacion Cadena Por valor Fecha de fabricacin. aFechaCaducidad Cadena Por valor Fecha de caducidad.



Descripcin Esta funcin agrega el movimiento de numero de serie, lote y/o pedimento asociados un movimiento cuyo producto maneje cualquiera de estas posibles configuraciones.

Ejemplo El siguiente cdigo da de alta un movimiento para un producto con numero de serie, lote y/o pedimento asociado.

lError = fAltaMovimientoSeriesCapas _Param (lIdMovimiento, lUnidades, lTipoCambio, lSeries, lPedimento, lAgencia, lFechaPedimento, lNumeroLote, lFechaFabricacion, lFechaCaducidad)

Ver tambin fInsertarDocumento(),fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(),

fBorraDocumento_CW(),fCancelarModificacionDocumento(),

Pgina: 56

fCalculaMovtoSerieCapa () Disponibilidad AdminPAQ 2004. Sintaxis fCalculaMovtoSerieCapa (aIdMovimiento)

Parmetros Nombre Tipo Uso Descripcin aIdMovimiento Entero largo Por valor Identificador del movimiento

a recalcular.


Descripcin Esta funcin recalcula el movimiento cuando este pertenece a un producto con series, lotes o pedimentos.

Ejemplo El siguiente cdigo recalcula el movimiento cuando este pertenece a un producto con series, lotes o pedimentos.

lError = fCalculaMovtoSerieCapa (lIdMovimiento)


Pgina: 57

fObtieneUnidadesPendientes () Disponibilidad AdminPAQ 2004. Sintaxis fObtieneUnidadesPendientes (aConceptoDocto, aCodigoProducto, aCodigoAlmacen,

aUnidades) Parmetros Nombre Tipo Uso Descripcin

aConceptoDocto Cadena Por valor Cdigo del concepto del documento a buscar.

aCodigoProducto Cadena Por valor Cdigo del producto a buscar su unidades pendientes.

aCodigoAlmacen Cadena Por valor Cdigo del almacn a buscar si es igual a 0 (cero) busca en todos los almacenes.

aUnidades Cadena Por referencia Valor de retorno con las unidades pendientes.



aUnidades: Al finalizar la funcin este parmetro contiene las unidades pendientes.

Descripcin Esta funcin obtiene la cantidad de unidades pendientes de cierto concepto de documento para un almacn/almacenes de un determinado producto en toda la historia del sistema.

Ejemplo El siguiente cdigo indica a la aplicacin que obtenga las unidades pendientes para el producto especificado en lCodigoProducto del almacen lCodigoAlmacen, del documento lConceptoDocto.

lError = fObtieneUnidadesPendientes (lConceptoDocto, lCodigoProducto, lCodigoAlmacen, lUnidades)



Pgina: 58

fObtieneUnidadesPendientesCarac () Disponibilidad AdminPAQ 2004. Sintaxis fObtieneUnidadesPendientesCarac (aConceptoDocto, aCodigoProducto, aCodigoAlmacen,

aValorCaracteristica1, aValorCaracteristica2, aValorCaracteristica3, aUnidades)

Parmetros Nombre Tipo Uso Descripcin aConceptoDocto Cadena Por valor Cdigo del concepto del

documento a buscar. aCodigoProducto Cadena Por valor Cdigo del producto a buscar

su unidades pendientes. aCodigoAlmacen Cadena Por valor Cdigo del almacn a buscar

si es igual a 0 (cero) busca en todos los almacenes.

aValorCaracteristica1 Cadena Por valor Valor caracterstica 1 aValorCaracteristica2 Cadena Por valor Valor caracterstica 2 aValorCaracteristica3 Cadena Por valor Valor caracterstica 3 aUnidades Cadena Por referencia Valor de retorno con las

unidades pendientes.


aUnidades: Al finalizar la funcin este parmetro contiene las unidades pendientes.

Descripcin Esta funcin obtiene la cantidad de unidades pendientes de cierto concepto de documento para un almacn/almacenes de un determinado producto con caracteristicas en toda la historia del sistema.

Ejemplo El siguiente cdigo indica a la aplicacin que obtenga las unidades pendientes para el producto especificado en lCodigoProducto del almacen lCodigoAlmacen, del documento lConceptoDocto.

lError = fObtieneUnidadesPendientes (lConceptoDocto, lCodigoProducto, lCodigoAlmacen, lUnidades)



Pgina: 59

fModificaCostoEntrada () Disponibilidad AdminPAQ 2005. Sintaxis fModificaCostoEntrada (aIdMovimiento, aCostoEntrada)

Parmetros Nombre Tipo Uso Descripcin aIdMovimiento Cadena Por valor Identificador del movimiento a

modificar. aCostoEntrada Cadena Por valor Valor del costo a asignar al

movimiento.


Descripcin Esta funcin modifica el costo de una entrada de inventario.

Ejemplo El siguiente cdigo indica a la aplicacin que modifique el costo de la entrada de inventario especificada en lIdMovimiento.

lError = fModificaCostoEntrada (lIdMovimiento, lCostoEntrada)


Pgina: 60

fSetDatoMovimiento () Disponibilidad AdminPAQ 2002. Sintaxis fSetDatoMovimiento (aCampo, aValor)

Parmetros Nombre Tipo Uso Descripcin aCampo Cadena Por valor Campo destino aValor Cadena Por valor Valor de escritura


Descripcin Esta funcin escribe el valor indicado en el campo correspondiente en el registro activo de la tabla de documentos.

Ejemplo El siguiente cdigo indica a la aplicacin que busque un movimiento por su identificador, en caso de que lo encuentre escribe el contenido de la variable lDescuento en el campo cDescuen01 de la tabla de movimientos; en caso contrario muestra el mensaje de error correspondiente.

lError = fBuscarIdMovimiento (lIdMovto) If lError 0 Then MensajeError lError Else lError = fSetDatoMovimiento ("cDescuen01 ", lDescuento) End If


Pgina: 61

fLeeDatoMovimiento () Disponibilidad AdminPAQ 2002. Sintaxis fLeeDatoMovimiento (aCampo, aValr, aLen)

Parmetros Nombre Tipo Uso Descripcin aCampo Cadena Por valor Campo destino. aValor Cadena Por referencia Valor de lectura. aLen Entero Por valor Longitud del dato de lectura.


aValor: Al finalizar la funcin este parmetro contiene el valor del campo especificado.


Ejemplo El siguiente cdigo indica a la aplicacin que busque un movimiento por su identificador, en caso de que lo encuentre escribe el contenido del campo cDescuen01 en la variable lDescuento con una longitud de 8 caracteres; en caso contrario muestra el mensaje de error correspondiente.

lError = fBuscarIdMovimiento (lIdMovto) If lError 0 Then MensajeError lError Else lError = fSetDatoMovimiento ("cDescuen01 ", lDescuento, 8) End If


Pgina: 62

Bajo Nivel Bsqueda/Navegacin fSetFiltroMovimiento ()

Disponibilidad AdminPAQ 2002. Sintaxis fSetFiltroMovimiento(aIdDocumento ) Parmetros Nombre Tipo Uso Descripcin

aIdDocumento Long Por valor Identificador del documento.


Descripcin Esta funcin aplica un filtro de movimientos de acuerdo al documento indicado.

Ejemplo El siguiente cdigo indica a la aplicacin que realice un filtro de movimientos para el documento especificado en el parmetro lIdDocto.

lError = fSetFiltroMovimiento (lIdDocto)

Ver tambin fInsertarDocumento(), fEditarDocumento(), fGuardaDocumento(), fBorraDocumento(), fBorraDocumento_CW(), fCancelarModificacionDocumento(),

fCancelaFiltroMovimiento ()

Disponibilidad AdminPAQ 2002. Sintaxis fCancelaFiltroMovimiento () Parmetros No usa. Retorna Valores enteros:


Descripcin Esta funcin aplica un filtro de movimientos de acuerdo al documento indicado.

Ejemplo El siguiente cdigo indica a la aplicacin que cancele el filtro de movimientos activo.

fCancelaFiltroMovimiento ()


Pgina: 63

fBuscarIdMovimiento () Disponibilidad AdminPAQ 2004. Sintaxis fBuscarIdMovimiento (aIdMovimiento)

Parmetros Nombre Tipo Uso Descripcin aIdMovimiento Entero Por valor Identificador del movimiento.



Descripcin Esta funcin busca un movimiento por su identificador. Si lo encuentra se posiciona en el registro correspondiente.

Ejemplo El siguiente cdigo busca un movimiento por su identificador.

fBuscarIdMovimiento (lIdMovimiento)


Pgina: 64

fPosPrimerMovimiento () Disponibilidad AdminPAQ 2002. Sintaxis fPosPrimerMovimiento ()



Descripcin Esta funcin se ubica en el primer registro de la tabla de movimientos.

Ejemplo El siguiente cdigo indica a la aplicacin que se posicione en el primer registro de la tabla de Movimientos.

lError = fPosPrimerMovimiento ()


fPosUltimoMovimiento ()

Disponibilidad AdminPAQ 2002. Sintaxis fPosUltimoMovimiento ()

Parmetros No usa.


Descripcin Esta funcin se ubica en el ultimo registro de la tabla de documentos.

Ejemplo El siguiente cdigo indica a la aplicacin que se posicione en el ultimo registro de la tabla de Movimientos.

lError = fPosUltimoMovimiento ()


Pgina: 65

fPosSiguienteMovimiento () Disponibilidad AdminPAQ 2002. Sintaxis fPosSiguienteMovimiento ()



Descripcin Esta funcin se ubica en el siguiente registro de la posicin actual de la tabla de documentos.

Ejemplo El siguiente cdigo indica a la aplicacin que se posicione en el siguiente registro de la tabla de Movimientos.

lError = fPosSiguienteMovimiento ()


fPosAnteriorMovimiento ()

Disponibilidad AdminPAQ 2002. Sintaxis fPosAnteriorMovimiento ()

Parmetros No usa.


Descripcin Esta funcin se ubica en el registro anterior de la posicin actual de la tabla de documentos.

Ejemplo El siguiente cdigo indica a la aplicacin que se posicione en el registro anterior de la tabla de Movimientos.

lError = fPosAnteriorMovimiento ()


Pgina: 66

fPosMovimientoBOF () Disponibilidad AdminPAQ 2002. Sintaxis fPosMovimientoBOF ()



Descripcin Informa si el registro activo se encuentra en el inicio de la tabla de Movimientos.

Ejemplo El siguiente cdigo indica a la aplicacin que asigne a la variable lInicioTablaMovto el resultado de la funcin fPosMovimientoBOF.

lInicioTablaMovto = fPosMovimientoBOF ()


99923910 Funciones SDK ADMW

Documents

Transcript of 99923910 Funciones SDK ADMW