Skip to content

misc_functions

shortfx.fxVBA.misc_functions

Access Miscellaneous Functions Module.

Description Funciones varias de VBA/Access: conversiones hex/oct, funciones Access-específicas (AccessError, CurrentUser, Eval, SysCmd).

Functions

AccessError(error_number: int) -> str

Description Retorna descripción asociada a error Access/DAO.

Args error_number: Código de error Access/DAO.

Returns str: Descripción del error.

Raises NotImplementedError: Cuando no se ejecuta en Access/DAO.

Usage Example >>> accesserror(3024) NotImplementedError

Cost N/A - Solo Access

Source code in shortfx/fxVBA/misc_functions.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def AccessError(error_number: int) -> str:
    """
    Description
        Retorna descripción asociada a error Access/DAO.

    Args
        error_number: Código de error Access/DAO.

    Returns
        str: Descripción del error.

    Raises
        NotImplementedError: Cuando no se ejecuta en Access/DAO.

    Usage Example
        >>> accesserror(3024)
        NotImplementedError

    Cost
        N/A - Solo Access
    """
    _access_only("AccessError")

CurrentUser() -> str

Description Retorna nombre del usuario actual de base de datos Access.

Returns str: Nombre de usuario.

Raises NotImplementedError: Cuando no se ejecuta en Access.

Usage Example >>> currentuser() NotImplementedError

Cost N/A - Solo Access

Source code in shortfx/fxVBA/misc_functions.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
def CurrentUser() -> str:
    """
    Description
        Retorna nombre del usuario actual de base de datos Access.

    Returns
        str: Nombre de usuario.

    Raises
        NotImplementedError: Cuando no se ejecuta en Access.

    Usage Example
        >>> currentuser()
        NotImplementedError

    Cost
        N/A - Solo Access
    """
    _access_only("CurrentUser")

Eval_(expression: str) -> Any

Description Interpreta/evalúa expresión numérica o función embebida. Retorna valor de referencia a objeto Access.

Args expression: Expresión VBA/Access a evaluar.

Returns Any: Resultado de evaluación.

Raises NotImplementedError: Cuando no se ejecuta en Access.

Usage Example >>> eval_("Forms!Main!Caption") NotImplementedError

Cost N/A - Solo Access

Source code in shortfx/fxVBA/misc_functions.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
def Eval_(expression: str) -> Any:
    """
    Description
        Interpreta/evalúa expresión numérica o función embebida.
        Retorna valor de referencia a objeto Access.

    Args
        expression: Expresión VBA/Access a evaluar.

    Returns
        Any: Resultado de evaluación.

    Raises
        NotImplementedError: Cuando no se ejecuta en Access.

    Usage Example
        >>> eval_("Forms!Main!Caption")
        NotImplementedError

    Cost
        N/A - Solo Access
    """
    _access_only("Eval")

Hex_(number: int) -> str

Description Retorna cadena equivalente a valor hexadecimal de número.

Args number: Número a convertir.

Returns str: Representación hexadecimal (sin prefijo 0x).

Usage Example >>> hex_(255) 'FF' >>> hex_(16) '10'

Cost O(log n) donde n es el número

Source code in shortfx/fxVBA/misc_functions.py 
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
def Hex_(number: int) -> str:
    """
    Description
        Retorna cadena equivalente a valor hexadecimal de número.

    Args
        number: Número a convertir.

    Returns
        str: Representación hexadecimal (sin prefijo 0x).

    Usage Example
        >>> hex_(255)
        'FF'
        >>> hex_(16)
        '10'

    Cost
        O(log n) donde n es el número
    """
    return hex(int(number))[2:].upper()

Oct_(number: int) -> str

Description Retorna cadena representando valor octal de número.

Args number: Número a convertir.

Returns str: Representación octal (sin prefijo 0o).

Usage Example >>> oct_(8) '10' >>> oct_(64) '100'

Cost O(log n) donde n es el número

Source code in shortfx/fxVBA/misc_functions.py 
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
def Oct_(number: int) -> str:
    """
    Description
        Retorna cadena representando valor octal de número.

    Args
        number: Número a convertir.

    Returns
        str: Representación octal (sin prefijo 0o).

    Usage Example
        >>> oct_(8)
        '10'
        >>> oct_(64)
        '100'

    Cost
        O(log n) donde n es el número
    """
    return oct(int(number))[2:]

QBColor(color: int) -> int

Description Retorna valor RGB correspondiente a código de color QuickBasic.

Args color: Código de color QuickBasic (0-15).

Returns int: Valor RGB.

Usage Example >>> qbcolor(0) # Negro 0 >>> qbcolor(4) # Rojo 255 >>> qbcolor(15) # Blanco brillante 16777215

Cost O(1)

Source code in shortfx/fxVBA/misc_functions.py 
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
def QBColor(color: int) -> int:
    """
    Description
        Retorna valor RGB correspondiente a código de color QuickBasic.

    Args
        color: Código de color QuickBasic (0-15).

    Returns
        int: Valor RGB.

    Usage Example
        >>> qbcolor(0)  # Negro
        0
        >>> qbcolor(4)  # Rojo
        255
        >>> qbcolor(15)  # Blanco brillante
        16777215

    Cost
        O(1)
    """
    # Paleta de 16 colores QuickBasic
    qb_colors = {
        0: RGB(0, 0, 0),           # Negro
        1: RGB(0, 0, 128),         # Azul
        2: RGB(0, 128, 0),         # Verde
        3: RGB(0, 128, 128),       # Cyan
        4: RGB(128, 0, 0),         # Rojo
        5: RGB(128, 0, 128),       # Magenta
        6: RGB(128, 128, 0),       # Amarillo/Marrón
        7: RGB(192, 192, 192),     # Blanco/Gris claro
        8: RGB(128, 128, 128),     # Gris
        9: RGB(0, 0, 255),         # Azul brillante
        10: RGB(0, 255, 0),        # Verde brillante
        11: RGB(0, 255, 255),      # Cyan brillante
        12: RGB(255, 0, 0),        # Rojo brillante
        13: RGB(255, 0, 255),      # Magenta brillante
        14: RGB(255, 255, 0),      # Amarillo brillante
        15: RGB(255, 255, 255),    # Blanco brillante
    }

    if color not in qb_colors:
        raise ValueError(f"Código de color QB debe estar entre 0 y 15, recibido: {color}")

    return qb_colors[color]

RGB(red: int, green: int, blue: int) -> int

Description Retorna valor entero que representa color RGB.

Args red: Componente rojo (0-255). green: Componente verde (0-255). blue: Componente azul (0-255).

Returns int: Valor RGB como entero (formato VBA).

Usage Example >>> rgb(255, 0, 0) # Rojo 255 >>> rgb(0, 255, 0) # Verde 65280 >>> rgb(0, 0, 255) # Azul 16711680

Cost O(1)

Source code in shortfx/fxVBA/misc_functions.py 
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
def RGB(red: int, green: int, blue: int) -> int:
    """
    Description
        Retorna valor entero que representa color RGB.

    Args
        red: Componente rojo (0-255).
        green: Componente verde (0-255).
        blue: Componente azul (0-255).

    Returns
        int: Valor RGB como entero (formato VBA).

    Usage Example
        >>> rgb(255, 0, 0)  # Rojo
        255
        >>> rgb(0, 255, 0)  # Verde
        65280
        >>> rgb(0, 0, 255)  # Azul
        16711680

    Cost
        O(1)
    """
    # VBA usa formato: R + (G * 256) + (B * 65536)
    if not (0 <= red <= 255 and 0 <= green <= 255 and 0 <= blue <= 255):
        raise ValueError("Valores RGB deben estar entre 0 y 255")

    return red + (green << 8) + (blue << 16)

SysCmd(action: int, argument2: Optional[int] = None, argument3: Optional[str] = None) -> Any

Description Ejecuta comando de sistema Access.

Args action: Código de acción SysCmd Access. argument2: Argumento entero opcional. argument3: Argumento cadena opcional.

Returns Any: Resultado según acción.

Raises NotImplementedError: Cuando no se ejecuta en Access.

Usage Example >>> syscmd(7) # Versión Access NotImplementedError

Cost N/A - Solo Access

Source code in shortfx/fxVBA/misc_functions.py 
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
def SysCmd(
    action: int,
    argument2: Optional[int] = None,
    argument3: Optional[str] = None
) -> Any:
    """
    Description
        Ejecuta comando de sistema Access.

    Args
        action: Código de acción SysCmd Access.
        argument2: Argumento entero opcional.
        argument3: Argumento cadena opcional.

    Returns
        Any: Resultado según acción.

    Raises
        NotImplementedError: Cuando no se ejecuta en Access.

    Usage Example
        >>> syscmd(7)  # Versión Access
        NotImplementedError

    Cost
        N/A - Solo Access
    """
    _access_only("SysCmd")