Referencia de funciones de sincronización de Azure Active Directory
Actualizado: 22 de julio de 2015
Importante
Este tema se archivará pronto.
Hay un nuevo producto denominado "Azure Active Directory Conectar" que reemplaza AADSync y DirSync.
Azure AD Connect incorpora los componentes y la funcionalidad publicados previamente como Dirsync y Sincronización de AAD.
En algún momento en el futuro, la compatibilidad con Dirsync y Sincronización de AAD finalizará.
Estas herramientas ya no se actualizan individualmente con mejoras de características y todas las mejoras futuras se incluirán en las actualizaciones de Azure AD Conectar.
En Azure Active Directory Sync, las funciones se usan para manipular un valor de atributo durante la sincronización.
La sintaxis de las funciones se expresa con el siguiente formato:
<tipo> de salida FunctionName(<nombre> de posición del tipo><de entrada, ..)
Si una función está sobrecargada y acepta varias sintaxis, se muestran todas las sintaxis válidas.
Las funciones están fuertemente tipadas y comprueban que el tipo pasado coincide con el tipo documentado. Si el tipo no coincide, se producirá un error.
Los tipos se expresan con la siguiente sintaxis:
bin : binario
bool : booleano
dt : fecha y hora UTC
enum : enumeración de constantes conocidas
exp : expresión, que se espera que evalúe en un booleano
mvbin: binario multivalor
mvstr: referencia multivalor
num : numérico
ref: referencia de un solo valor
str: cadena de un solo valor
var : una variante de (casi) cualquier otro tipo
void : no devuelve un valor
Lista de funciones
Esta sección contiene descripciones de las funciones siguientes:
BitAnd
BitOr
CBool
CDate
CGuid
Contiene
ConvertFromBase64
ConvertFromUTF8Hex
ConvertToBase64
ConvertToUTF8Hex
Count
CNum
CRef
CStr
DateAdd
DateFromNum
DNComponent
DNComponentRev
Error
EscapeDNComponent
FormatDateTime
GUID
IIF
InStr
InStrRev
IsBitSet
IsDate
IsEmpty
IsGuid
IsNull
IsNullOrEmpty
IsNumeric
IsString
IsPresent
Elemento
ItemOrNull
Join
LCase
Left
Len
LTrim
Mid
Ahora
NumFromDate
PadLeft
PadRight
PCase
RandomNum
RemoveDuplicates
Replace
ReplaceChars
Right
RTrim
Dividir
StringFromGuid
StringFromSid
Modificador
Trim
UCase
Word
BitAnd
Descripción |
: la función BitAnd establece los bits especificados en un valor. |
Sintaxis |
num BitAnd(num value1, num value2) value1, value2: valores numéricos que deben estar juntos |
Comentarios: |
Esta función convierte ambos parámetros en representación binaria y establece un bit en 0 si uno o ambos bits correspondientes de máscara y marca son 0, y en 1 si ambos bits correspondientes son 1. En otras palabras, devuelve 0 en todos los casos excepto cuando los bits correspondientes de ambos parámetros son 1. |
Ejemplo |
BitAnd(&HF, &HF7) // Da como resultado 7, ya que “F” hexadecimal AND “F7” hexadecimal da como resultado este valor. |
BitOr
Descripción |
: la función BitOr establece los bits especificados en un valor. |
Sintaxis |
num BitOr(num value1, num value2) value1, value2: valores numéricos que deben ser or'ed juntos |
Comentarios: |
Esta función convierte ambos parámetros en representación binaria y establece un bit en 1 si uno o ambos bits correspondientes de máscara y marca son 1, y en 0 si ambos bits correspondientes son 0. En otras palabras, devuelve 1 en todos los casos excepto cuando los bits correspondientes de ambos parámetros son 0. |
Ejemplo |
CBool
Descripción |
: la función CBool devuelve un valor booleano basado en la expresión evaluada. |
Sintaxis |
bool CBool(exp Expression) |
Comentarios: |
Si la expresión da como resultado un valor distinto de cero, CBool devuelve True. En caso contrario, devuelve False. |
Ejemplo |
CBool([attrib1] = [attrib2]) // Devuelve True si ambos atributos tienen el mismo valor. |
CDate
Descripción |
: la función CDate devuelve un valor DateTime UTC a partir de una cadena. DateTime no es un tipo de atributo nativo en Sincronización pero lo usan algunas funciones. |
Sintaxis |
dt CDate(str value) Valor: una cadena con una fecha, hora y opcionalmente, una zona horaria |
Comentarios: |
: la cadena devuelta siempre es UTC. |
Ejemplo |
CDate([employeeStartTime]) // Devuelve una fecha y hora basada en la hora de inicio del empleado CDate("2013-01-10 4:00 PM -8") // Devuelve una fecha y hora que representa "11-01-2013 12:00 a.m." |
CGuid
Descripción |
La función CGuid convierte la representación de cadena de un Guid en una representación binaria del Guid. |
Sintaxis |
bin CGuid(str GUID)GUID: una cadena con formato en este patrón: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx o {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx} |
Comentarios: |
|
Ejemplo |
Contiene
Descripción |
: la función Contains busca una cadena dentro de un atributo multivalor. |
Sintaxis |
num Contains (mvstring attribute, str search) // distingue entre mayúsculas y minúsculas num Contains (mvstring attribute, str search, enum Casetype) num Contains (mvref attribute, str search) // distingue entre mayúsculas y minúsculas attribute: el atributo con varios valores de búsqueda. Search: cadena que se va a buscar en el atributo . Casetype: CaseInsensitive o CaseSensitive Devuelve el índice en el atributo de varios valores donde se ha encontrado la cadena. Si no se encuentra la cadena, se devuelve 0. |
Comentarios: |
Para los atributos de cadena multivalor, la búsqueda encontrará subcadenas en los valores. Para los atributos de referencia, la cadena de búsqueda debe coincidir exactamente con el valor para que se considere una coincidencia. |
Ejemplo |
IIF(Contains([proxyAddresses],"SMTP:")>0,[proxyAddresses],Error("No se encontró ninguna dirección SMTP principal.")) Si el atributo proxyAddresses tiene una dirección de correo electrónico principal (indicada por "SMTP:") en mayúsculas, devuelva el atributo proxyAddress; de lo contrario, devuelve un error. |
ConvertFromBase64
Descripción |
: la función ConvertFromBase64 convierte el valor codificado en base64 especificado en una cadena normal. |
Sintaxis |
str ConvertFromBase64(str source) // se supone Unicode para la codificación str ConvertFromBase64(str source, enum Encoding) Origen: cadena codificada en Base64 Encoding: Unicode, ASCII, UTF8 |
Comentarios: |
|
Ejemplo |
ConvertFromBase64("SABlAGwAbABvACAAdwBvAHIAbABkACEA") ConvertFromBase64("SGVsbG8gd29ybGQh", UTF8) // Ambos devuelven "Hello world!" |
ConvertFromUTF8Hex
Descripción |
: la función ConvertFromUTF8Hex convierte el valor codificado hexadecimal UTF8 especificado en una cadena. |
Sintaxis |
str ConvertFromUTF8Hex(str source) source: cadena codificada de 2 bytes UTF8 |
Comentarios: |
Esta función difiere de ConvertFromBase64([],UTF8) en que el resultado es descriptivo para el atributo DN. Este formato se utiliza en Azure Active Directory como DN. |
Ejemplo |
ConvertFromUTF8Hex("48656C6C6F20776F726C6421") // Devuelve "Hello world!" |
ConvertToBase64
Descripción |
La función ConvertToBase64 convierte una cadena en una en base64 de Unicode. Convierte el valor de una matriz de enteros en su representación de cadena equivalente que se codifica con dígitos de base 64. |
Sintaxis |
str ConvertToBase64(str source) |
Observaciones |
|
Ejemplo |
ConvertToBase64("Hello world!") // Devuelve "SABlAGwAbABvACAAdwBvAHIAbABkACEA" |
ConvertToUTF8Hex
Descripción |
: la función ConvertToUTF8Hex convierte una cadena en un valor codificado hexadecimal UTF8. |
Sintaxis |
str ConvertToUTF8Hex(str source) |
Comentarios: |
El formato de salida de esta función se utiliza en Azure Active Directory como formato del atributo DN. |
Ejemplo |
ConvertToUTF8Hex("Hello world!") // Devuelve 48656C6C6F20776F726C6421 |
Count
Descripción |
: la función Count devuelve el número de elementos en un atributo multivalor. |
Sintaxis |
num Count(mvstr attribute) |
Comentarios: |
|
Ejemplo |
CNum
Descripción |
: la función CNum toma una cadena y devuelve un tipo de datos numérico. |
Sintaxis |
num CNum(str value) |
Comentarios: |
|
Ejemplo |
CRef
Descripción |
: convierte una cadena en un atributo de referencia. |
Sintaxis |
ref CRef(str value) |
Comentarios: |
|
Ejemplo |
CRef("CN=LC Services,CN=Microsoft,CN=lcspool01, CN=Pools,CN=RTC Service," & %Forest.LDAP%) |
CStr
Descripción |
: la función CStr se convierte en un tipo de datos de cadena. |
Sintaxis |
str CStr(num value) str CStr(ref value) str CStr(bool value) Valor: puede ser un valor numérico, un atributo de referencia o un valor booleano. |
Comentarios: |
|
Ejemplo |
CStr([dn]) // Podría devolver “cn=Joe,dc=contoso,dc=com” |
DateAdd
Descripción |
: devuelve un valor Date que contiene una fecha a la que se ha agregado un intervalo de tiempo especificado. |
Sintaxis |
dt DateAdd(str interval, num value, dt date) Interval: expresión de cadena que es el intervalo de tiempo que desea agregar. La cadena debe tener uno de los siguientes valores: yyyy Año q Trimestre mMonth yDay of year dDay wWeekday wwWeek hHour nMinute sSecond Valor: número de unidades que desea agregar. Puede ser positivo (para obtener fechas futuras) o negativo (para obtener fechas del pasado). Date: DateTime que representa la fecha a la que se agrega el intervalo. |
Comentarios: |
|
Ejemplo |
DateAdd("m", 3, CDate("2001-01-01")), // Agrega 3 meses y devuelve un valor de fecha y hora que representa "01-04-2001” |
DateFromNum
Descripción |
: la función DateFromNum convierte un valor con formato de fecha de AD en un tipo DateTime. |
Sintaxis |
dt DateFromNum(num value) |
Comentarios: |
|
Ejemplo |
DateFromNum([lastLogonTimestamp]) DateFromNum(129699324000000000) // Devuelve un valor de fecha y hora que representa 01-01-2012 00:23:00 |
DNComponent
Descripción |
: la función DNComponent devuelve el valor de un componente DN especificado empezando por la izquierda. |
Sintaxis |
str DNComponent(ref dn, num ComponentNumber) dn: el atributo de referencia que interpretar ComponentNumber: el componente en DN para devolver |
Comentarios: |
|
Ejemplo |
DNComponent([dn],1) Si dn es "cn=Joe,ou=... esto devolvería a Joe |
DNComponentRev
Descripción |
: la función DNComponentRev devuelve el valor de un componente DN especificado empezando por la derecha (final). |
Sintaxis |
str DNComponentRev(ref dn, num ComponentNumber) str DNComponentRev(ref dn, num ComponentNumber, enum Options)dn: el atributo de referencia para interpretar ComponentNumber: el componente en DN para devolver Opciones: DC: omitir todos los componentes con "dc=" |
Comentarios: |
|
Ejemplo |
// Si dn es “cn=Joe,ou=Atlanta,ou=GA,ou=US, dc=contoso,dc=com”, entonces DNComponentRev([dn],3) DNComponentRev([dn],1,”DC”) // Ambos devolverían US. |
Error
Descripción |
: la función Error se usa para devolver un error personalizado. |
Sintaxis |
void Error(str ErrorMessage) |
Comentarios: |
|
Ejemplo |
IIF(IsPresent([accountName]),[accountName],Error(“AccountName is required”)) // Si el atributo accountName no está presente, se produce un error en el objeto. |
EscapeDNComponent
Descripción |
: la función EscapeDNComponent toma un componente de DN y genera secuencias de escape para poder representarlo en LDAP. |
Sintaxis |
str EscapeDNComponent(str value) |
Comentarios: |
|
Ejemplo |
EscapeDNComponent("cn=" & [displayName]) & "," & %ForestLDAP% // Se asegura de que el objeto puede crearse en un directorio LDAP, incluso si el atributo displayName tiene caracteres a los que debe aplicarse una secuencia de escape en LDAP. |
FormatDateTime
Descripción |
: la función FormatDateTime se usa para dar formato a un valor DateTime en una cadena con un formato especificado. |
Sintaxis |
str FormatDateTime(dt value, str format)value: un valor en el formato DateTime format: una cadena que representa el formato de conversión. |
Comentarios: |
Los valores posibles para el formato pueden encontrarse aquí: |
Ejemplo |
FormatDateTime(CDate(“12/25/2007”),”yyyy-mm-dd”) // Da como resultado “25-12-2007”. FormatDateTime(DateFromNum([pwdLastSet]),”yyyyMMddHHmmss.0Z”) // Puede dar como resultado “20140905081453.0Z” |
GUID
Descripción |
: la función GUID genera un nuevo GUID aleatorio. |
Sintaxis |
GUID de str() |
Comentarios: |
|
Ejemplo |
IIF
Descripción |
: la función IIF devuelve uno de un conjunto de valores posibles según una condición especificada. |
Sintaxis |
var IIF(exp condition, var valueIfTrue, var valueIfFalse)condition: cualquier valor o expresión que se pueda evaluar como true o false. valueIfTrue: un valor que se devolverá si condition se evalúa como true. valueIfFalse: un valor que se devolverá si la condición se evalúa como false. |
Comentarios: |
|
Ejemplo |
IIF([employeeType]="Intern","t-"&[alias],[alias]) // Devuelve el alias de un usuario agregando “t-” al principio de dicho alias si el usuario es una persona en prácticas; en caso contrario, devuelve el alias del usuario tal cual. |
InStr
Descripción |
: la función InStr busca la primera repetición de una subcadena en una cadena. |
Sintaxis |
num InStr(str stringcheck, str stringmatch) num InStr(str stringcheck, str stringmatch, num start) num InStr(str stringcheck, str stringmatch, num start , enum compare) Stringcheck: cadena en la que se va a buscar Stringmatch: cadena que se va a encontrar Inicio: posición inicial para buscar la subcadena Compare: vbTextCompare o vbBinaryCompare |
Observaciones |
: devuelve la posición en la que se encontró la subcadena o 0 si no se encuentra. |
Ejemplo |
InStr("The quick brown fox","quick") // Da como resultado 5 InStr("repEated","e",3,vbBinaryCompare) // Da como resultado 7 |
InStrRev
Descripción |
: la función InStrRev busca la última repetición de una subcadena en una cadena. |
Sintaxis |
num InstrRev(str stringcheck, str stringmatch) num InstrRev(str stringcheck, str stringmatch, num start) num InstrRev(str stringcheck, str stringmatch, num start, enum compare) Stringcheck: cadena en la que se va a buscar Stringmatch: cadena que se va a encontrar Inicio: posición inicial para buscar la subcadena Compare: vbTextCompare o vbBinaryCompare |
Comentarios: |
: devuelve la posición en la que se encontró la subcadena o 0 si no se encuentra. |
Ejemplo |
InStrRev("abbcdbbbef","bb") // Da como resultado 7 |
IsBitSet
Descripción |
la función IsBitSet prueba si un bit se establece o no. |
Sintaxis |
bool IsBitSet(num value, num flag) value: un valor numérico que es evaluated.flag: un valor numérico que tiene el bit que se va a evaluar |
Comentarios: |
|
Ejemplo |
IsBitSet(&HF,4) // Da como resultado true, ya que el bit “4” está establecido en el valor hexadecimal “F” |
IsDate
Descripción |
La función IsDate da como resultado true si la expresión puede evaluarse como un tipo de fecha y hora. |
Sintaxis |
bool IsDate(var Expression) |
Comentarios: |
Se utiliza para determinar si CDate() será correcto. |
Ejemplo |
IsEmpty
Descripción |
La función IsEmpty da como resultado true si el atributo está presente en el CS o MV pero da como resultado una cadena vacía. |
Sintaxis |
bool IsEmpty(var Expression) |
Comentarios: |
|
Ejemplo |
IsGuid
Descripción |
La función IsGuid da como resultado true si se pudo convertir la cadena en un GUID. |
Sintaxis |
bool IsGuid(str GUID) |
Comentarios: |
un GUID se define como una cadena que sigue uno de estos patrones: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx or {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. Se utiliza para determinar si CGuid() será correcto. |
Ejemplo |
IIF(IsGuid([strAttribute]),CGuid([strAttribute]),NULL) // Si StrAttribute tiene un formato GUID, devuelve una representación binaria; en caso contrario, devuelve null. |
IsNull
Descripción |
La función IsNull devuelve true si la expresión da como resultado null. |
Sintaxis |
bool IsNull(var Expression) |
Comentarios: |
para un atributo, un valor Null se expresa mediante la ausencia del atributo. |
Ejemplo |
IsNull([displayName]) // Da como resultado true si el atributo no está presente en el CS o MV. |
IsNullOrEmpty
Descripción |
La función IsNullOrEmpty devuelve true si la expresión es null o una cadena vacía. |
Sintaxis |
bool IsNullOrEmpty(var Expression) |
Comentarios: |
para un atributo, esto se evaluaría como True si el atributo no está presente o está presente, pero es una cadena vacía. La función contraria a esta es IsPresent. |
Ejemplo |
IsNull([displayName]) // Da como resultado true si el atributo no está presente o si es una cadena vacía en el CS o MV. |
IsNumeric
Descripción |
la función IsNumeric devuelve un valor booleano que indica si una expresión se puede evaluar como un tipo de número. |
Sintaxis |
bool IsNumeric(var Expression) |
Comentarios: |
Se utiliza para determinar si CNum() será correcto para analizar la expresión. |
Ejemplo |
IsString
Descripción |
La función IsString da como resultado true si la expresión se puede evaluar como un tipo de cadena. |
Sintaxis |
bool IsString(var expression) |
Comentarios: |
Se utiliza para determinar si CStr() será correcto para analizar la expresión. |
Ejemplo |
IsPresent
Descripción |
La función IsPresent devuelve true si la expresión da como resultado una cadena que no es null y que no está vacía. |
Sintaxis |
bool IsPresent(var expression) |
Comentarios: |
la función contraria a esta es IsNullOrEmpty. |
Ejemplo |
Switch(IsPresent([directManager]),[directManager], IsPresent([skiplevelManager]),[skiplevelManager], IsPresent([director]),[director]) |
Elemento
Descripción |
la función Item devuelve un elemento de un atributo o una cadena de varios valores. |
Sintaxis |
var Item(mvstr attribute, num index) attribute: atributo de varios valores index: índice para un elemento en la cadena de varios valores. |
Comentarios: |
La función Item es útil junto con la función Contains, ya que esta última función devolverá el índice a un elemento del atributo multivalor. Se produce un error si el índice está fuera de los límites. |
Ejemplo |
Mid(Item([proxyAddress],Contains([proxyAddress], ”SMTP:”)),6) // Devuelve la dirección de correo electrónico principal. |
ItemOrNull
Descripción |
la función ItemOrNull devuelve un elemento de un atributo o una cadena de varios valores. |
Sintaxis |
var ItemOrNull(mvstr attribute, num index) attribute: atributo de varios valores index: índice para un elemento en la cadena de varios valores. |
Comentarios: |
La función ItemOrNull es útil junto con la función Contains, ya que esta última función devolverá el índice a un elemento del atributo multivalor. Devuelve un valor null si el índice está fuera de los límites. |
Ejemplo |
Join
Descripción |
la función Join toma una cadena de varios valores y devuelve una cadena de valor único con un separador especificado insertado entre cada elemento. |
Sintaxis |
str Join(mvstr attribute) str Join(mvstr attribute, str Delimiter)attribute: atributo multivalor que contiene cadenas que se van a combinar. Delimitador: cualquier cadena, que se usa para separar las subcadenas de la cadena devuelta. Si se omite, se usa el carácter de espacio (""). Si delimitador es una cadena de longitud cero ("") o nada, todos los elementos de la lista se concatenan sin delimitadores. |
Comentarios: |
hay paridad entre las funciones Join y Split. La función Join toma una matriz de cadenas y las combina con una cadena de delimitación para devolver una sola cadena. La función Split toma una cadena y la separa en el delimitador para devolver una matriz de cadenas. Sin embargo, una diferencia clave es que Join puede concatenar cadenas con cualquier cadena de delimitación, mientras que attribute puede separar solo cadenas mediante un delimitador de carácter único. |
Ejemplo |
Join([proxyAddresses],”,”) Podría devolver: "SMTP:john.doe@contoso.com,smtp:jd@contoso.com" |
LCase
Descripción |
la función LCase convierte todos los caracteres de una cadena a minúsculas. |
Sintaxis |
str LCase(str value) |
Comentarios: |
|
Ejemplo |
LCase(“TeSt”) // Da como resultado “test”. |
Left
Descripción |
la función Left devuelve un número especificado de caracteres desde la izquierda de una cadena. |
Sintaxis |
str Left(str string, num NumChars)string: la cadena desde la que se van a devolver caracteres NumChars: un número que identifica el número de caracteres que devolver desde el principio (izquierdo) de la cadena |
Comentarios: |
Cadena que contiene los primeros caracteres numChars de la cadena. • Si numChars = 0, devuelve una cadena vacía. •Si numChars < 0, devuelva la cadena de entrada. • Si cadena es null, devuelve una cadena vacía. Si la cadena contiene menos caracteres que el número especificado en numChars, se devuelve una cadena idéntica a la cadena (es decir, que contiene todos los caracteres del parámetro 1). |
Ejemplo |
Left(“John Doe”, 3) // Devuelve Devolvería “Joh”. |
Len
Descripción |
La función Num devuelve el número de caracteres de una cadena. |
Sintaxis |
num Len(str value) |
Comentarios: |
|
Ejemplo |
Len(“John Doe”) // Devuelve 8 |
LTrim
Descripción |
la función LTrim quita los espacios en blanco del principio de una cadena. |
Sintaxis |
str LTrim(str value) |
Comentarios: |
|
Ejemplo |
LTrim(" Test ") Da como resultado "Prueba" |
Mid
Descripción |
la función Mid devuelve un número especificado de caracteres desde una posición especificada en una cadena. |
Sintaxis |
str Mid(str string, num start, num NumChars) string: la cadena desde la que devolver los caracteres start: un número que identifica la posición de inicio en una cadena desde la que devolver los caracteres NumChars: un número que identifica el número de caracteres que devolver desde la posición en una cadena |
Comentarios: |
devuelve caracteres numChars que comienzan por la posición de inicio en una cadena. Cadena que contiene caracteres numChars a partir de la posición de inicio en la cadena. • Si numChars = 0, devuelve una cadena vacía. •Si numChars < 0, devuelva la cadena de entrada. •Si inicia > la longitud de la cadena, devuelva la cadena de entrada. •Si start <= 0, devuelva la cadena de entrada. • Si cadena es null, devuelve una cadena vacía. Si no hay caracteres numChar restantes en la cadena a partir de la posición de inicio, se devuelven todos los caracteres que se puedan devolver. |
Ejemplo |
Mid(“John Doe”, 3, 5) // Devuelve “hn Do”. Mid("John Doe", 6, 999) // Devuelve “Doe” |
Ahora
Descripción |
La función Now devuelve una fecha y hora que especifica la fecha y la hora actuales, según la fecha y la hora del sistema del equipo. |
Sintaxis |
dt Now() |
Comentarios: |
|
Ejemplo |
NumFromDate
Descripción |
la función NumFromDate devuelve una fecha en formato de fecha de AD. |
Sintaxis |
num NumFromDate(dt value) |
Comentarios: |
|
Ejemplo |
NumFromDate(CDate("2012-01-01 23:00:00")) // Devuelve 129699324000000000 |
PadLeft
Descripción |
la función PadLeft rellena en la parte izquierda una cadena con una longitud especificada mediante un carácter de espaciado interno proporcionado. |
Sintaxis |
str PadLeft(str string, num length, str padCharacter) string: la cadena que rellenar. length: un número entero que representa la longitud deseada de la cadena. padCharacter: una cadena que consta de un solo carácter que se usará como el carácter controlador |
Comentarios: |
Si la longitud de cadena es inferior a la longitud, padCharacter se anexa repetidamente al principio (izquierda) de la cadena hasta que tenga una longitud igual a la longitud. PadCharacter puede ser un carácter de espacio, pero no puede ser un valor Null. Si la longitud de cadena es igual o mayor que la longitud, la cadena se devuelve sin cambios. Si la cadena tiene una longitud mayor que o igual que la longitud, se devuelve una cadena idéntica a la cadena. Si la longitud de cadena es menor que la longitud, se devuelve una cadena nueva de la longitud deseada que contiene una cadena rellenada con un padCharacter. Si la cadena es Null, la función devuelve una cadena vacía. |
Ejemplo |
PadLeft(“User”, 10, “0”) // Da como resultado “000000User”. |
PadRight
Descripción |
la función PadRight rellena en la parte derecha una cadena con una longitud especificada mediante un carácter de espaciado interno proporcionado. |
Sintaxis |
str PadRight(str string, num length, str padCharacter) string: la cadena que rellenar. length: un número entero que representa la longitud deseada de la cadena. padCharacter: una cadena que consta de un solo carácter que se usará como el carácter controlador |
Comentarios: |
Si la longitud de cadena es inferior a la longitud, padCharacter se anexa repetidamente al final (derecha) de la cadena hasta que tenga una longitud igual a la longitud. PadCharacter puede ser un carácter de espacio, pero no puede ser un valor Null. Si la longitud de cadena es igual o mayor que la longitud, la cadena se devuelve sin cambios. Si la cadena tiene una longitud mayor que o igual que la longitud, se devuelve una cadena idéntica a la cadena. Si la longitud de cadena es menor que la longitud, se devuelve una cadena nueva de la longitud deseada que contiene una cadena rellenada con un padCharacter. Si la cadena es Null, la función devuelve una cadena vacía. |
Ejemplo |
PadRight(“User”, 10, “0”) // Da como resultado “User000000”. |
PCase
Descripción |
la función PCase convierte el primer carácter de cada palabra delimitada por espacios de una cadena a mayúsculas, y todos los demás caracteres se convierten a minúsculas. |
Sintaxis |
String PCase(string) |
Comentarios: |
|
Ejemplo |
PCase(“TEsT”) // Da como resultado “Test”. |
RandomNum
Descripción |
la función RandomNum devuelve un número aleatorio entre un intervalo especificado. |
Sintaxis |
num RandomNum(num start, num end) start: un número que identifica el límite inferior del valor aleatorio que se va a generar end: un número que identifica el límite superior del valor aleatorio que generar |
Comentarios: |
|
Ejemplo |
Random(100,999) // Podría devolver 734. |
RemoveDuplicates
Descripción |
la función RemoveDuplicates toma una cadena multivalor y garantiza que cada valor es único. |
Sintaxis |
mvstr RemoveDuplicates(mvstr attribute) |
Comentarios: |
|
Ejemplo |
RemoveDuplicates([proxyAddresses]) // Devuelve un atributo proxyAddress saneado donde se han quitado todos los valores duplicados. |
Replace
Descripción |
la función Replace reemplaza todas las apariciones de una cadena por otra cadena. |
Sintaxis |
str Replace(str string, str OldValue, str NewValue) string: una cadena en la que se reemplazarán los valores. OldValue: la cadena que se va a buscar y reemplazar. NewValue: la cadena que reemplazar. |
Comentarios: |
La función reconoce los monikers especiales siguientes. \n: nueva línea \r: retorno de carro \t: tabulación |
Ejemplo |
Replace([address],”\r\n”,”, “) // Reemplaza CRLF por una coma y un espacio, y puede dar como resultado "One Microsoft Way, Redmond, WA, EE. UU." |
ReplaceChars
Descripción |
la función ReplaceChars reemplaza todas las apariciones de caracteres encontrados en la cadena ReplacePattern. |
Sintaxis |
str ReplaceChars(str string, str ReplacePattern) string: una cadena por la que reemplazar los caracteres. ReplacePattern: una cadena que contiene un diccionario con caracteres que reemplazar. El formato es {source1}:{target1},{source2}:{target2},{sourceN},{targetN} donde source es el carácter que buscar y target la cadena por la que reemplazar. |
Comentarios: |
La función tomará cada aparición de los orígenes definidos y los reemplazará con los destinos. El origen debe ser exactamente un carácter (unicode). El origen no puede estar vacío ni puede tener más de un carácter (error de análisis). El destino puede tener varios caracteres, por ejemplo, ö:oe, β:ss. El destino puede estar vacío, lo que indica que el carácter debe quitarse. El origen distingue mayúsculas de minúsculas y debe ser una coincidencia exacta. La coma (,) y los dos puntos (:) son caracteres reservados y no se puede reemplazar utilizando esta función. Se omiten los espacios y otros caracteres en blanco en la cadena ReplacePattern. |
Ejemplo |
%ReplaceString% = ':,Å:A,Ä:A,Ö:O,å:a,ä:a,ö,o ReplaceChars("Räksmörgås",%ReplaceString%) // Devuelve Raksmorgas ReplaceChars(“O’Neil”,%ReplaceString%) // Devuelve “ONeil”, ya que se definió que se quitase el apóstrofo. |
Right
Descripción |
la función Right devuelve un número especificado de caracteres desde la derecha (final) de una cadena. |
Sintaxis |
str Right(str string, num NumChars) string: la cadena desde la que devolver los caracteres NumChars: un número que identifica el número de caracteres que devolver desde el final (derecho) de la cadena |
Observaciones |
los caracteres NumChars se devuelven a partir de la última posición de la cadena. Cadena que contiene los últimos caracteres numChars de la cadena. • Si numChars = 0, devuelve una cadena vacía. •Si numChars < 0, devuelva la cadena de entrada. • Si cadena es null, devuelve una cadena vacía. Si la cadena contiene menos caracteres que el número especificado en NumChars, se devuelve una cadena idéntica a la cadena. |
Ejemplo |
Right(“John Doe”, 3) // Devuelve “Doe”. |
RTrim
Descripción |
la función RTrim quita los espacios en blanco del final de una cadena. |
Sintaxis |
str RTrim(str value) |
Comentarios: |
|
Ejemplo |
RTrim(" Test ") Da como resultado "Test". |
Dividir
Descripción |
la función Split toma una cadena separada por un delimitador y la convierte en una cadena multivalor. |
Sintaxis |
mvstr Split(str value, str delimiter) mvstr Split(str value, str delimiter, num limit) Valor: la cadena con un carácter delimitador que se va a separar. Delimitador: carácter único que se va a usar como delimitador Límite: número máximo de valores que se devolverán |
Comentarios: |
|
Ejemplo |
Split("SMTP:john.doe@contoso.com,smtp:jd@contoso.com",",") // Devuelve una cadena multivalor con 2 elementos útiles para el atributo proxyAddress |
StringFromGuid
Descripción |
la función StringFromGuid toma un GUID binario y lo convierte en una cadena. |
Sintaxis |
str StringFromGuid(bin GUID) |
Comentarios |
|
Ejemplo |
StringFromSid
Descripción |
La función StringFromSid convierte una matriz de bytes o una matriz de bytes multivalor que contiene un identificador de seguridad en una cadena o en una cadena multivalor. |
Sintaxis |
str StringFromSid(bin ObjectSID) mvstr StringFromSid(mvbin ObjectSID) |
Comentarios: |
|
Ejemplo |
Modificador
Descripción |
la función Switch se utiliza para devolver un único valor según las condiciones evaluadas. |
Sintaxis |
var Switch(expr1, var value1[, exp expr2, var value ... [, expr, var valueN]]) Expr: expresión variant que desea evaluar. Valor: valor que se va a devolver si la expresión correspondiente es True. |
Comentarios: |
la lista de argumentos de la función Switch consta de pares de expresiones y valores. Las expresiones se evalúan de izquierda a derecha y se devuelve el valor asociado a la primera expresión que evaluar en True. Si los elementos no están emparejados correctamente, se produce un error en tiempo de ejecución. Por ejemplo, si expr1 es True, Switch devuelve value1. Si expr-1 es False, pero expr-2 es True, Switch devuelve value-2, etc. Switch devuelve Nothing si:
Switch evalúa todas las expresiones, aunque solo devuelve una. Por este motivo, debe vigilar efectos secundarios no deseados. Por ejemplo, si la evaluación de cualquier expresión tiene como resultado una división por cero, se produce un error. Value también puede ser la función Error que devuelve una cadena personalizada. |
Ejemplo |
Switch([city] = "London", "English", [city] = "Rome", "Italian", [city] = "Paris", "French", True, Error(“Unknown city”)) // Devuelve el idioma hablado en algunas ciudades importantes; en caso contrario, devuelve un error. |
Trim
Descripción |
la función Trim quita los espacios en blanco del principio y del final de una cadena. |
Sintaxis |
str Trim(str value) mvstr Trim(mvstr value) |
Comentarios: |
|
Ejemplo |
Trim(" Test ") // Da como resultado “Test”. Trim([proxyAddresses]) // Se eliminarán los espacios iniciales y finales para cada valor del atributo proxyAddress. |
UCase
Descripción |
: la función UCase convierte todos los caracteres de una cadena a mayúsculas. |
Sintaxis |
str UCase(str string) |
Comentarios: |
|
Ejemplo |
UCase(“TeSt”) // Da como resultado “TEST”. |
Word
Descripción |
: la función Word devuelve una palabra incluida en una cadena, según los parámetros que describen los delimitadores que se usarán y el número de palabras que se devolverán. |
Sintaxis |
str Word(str string, num WordNumber, str delimiters) string: la cadena desde la que se va a devolver una palabra WordNumber: número que identifica qué número de palabra se debe devolver delimiters: una cadena que representa los delimitadores que deben usarse para identificar palabras |
Comentarios: |
Las cadenas de caracteres en una cadena separadas por uno de los caracteres de los delimitadores se identifican como palabras. •Si el número < 1, devuelve una cadena vacía. • Si cadena es null, devuelve una cadena vacía. Si la cadena contiene palabras menores que el número o si la cadena no contiene ninguna palabra identificada por delimitadores, se devuelve una cadena vacía. |
Ejemplo |
Word(“The quick brown fox”,3,” “) // Devuelve “brown” Word("This,string!has&many seperators",3,",!& #") // Devuelve “has” |